Differenze tra le versioni di "Vendita e ricarica online del titolo di viaggio"

Da Libro Bianco OpenPass.
[versione bozza][versione bozza]
(→‎Parametri in uscita: : modifica contenuti)
(→‎(STEP 6) - Generazione della tessere relativa alla vendita: : aggiunta contenuti)
Riga 649: Riga 649:
  
 
=== (STEP 6) - Generazione della tessere relativa alla vendita ===
 
=== (STEP 6) - Generazione della tessere relativa alla vendita ===
 +
Ricevute la transazioni di vendita relative a tutti i domini della specifica company, i fornitori dei sistemi di accesso, sono in grado di generare i biglietti:
 +
* emettere dalle emettitrici i nuovi biglietti
 +
* ricaricare alle antenne le tessere in formato OpenPass.
 +
 +
Successivamente a tali azioni, i fornitori dei sistemi di accesso, dovranno utilizzare il nuovo servizio GenerateTicket per inviare al Server OpenPass i token Root.Workstation, Root.SerialNumberEx2 e la data di creazione della tessera con cui è stato generato il biglietto per ogni specifica transazione di vendita identificata con RegisterWebSaleID.
 +
 +
I dati inviati dai fornitori dei sistemi di accesso, successivamente alla generazione della tessera contnenete la transazione di vendita sono:
 +
* Group
 +
* Company
 +
* Workstation
 +
* Creationtime
 +
* Ticketidentifier
 +
* OpenPassUID
 +
* RegisterWebSaleID
 +
* SerialNumberEx2
 +
 +
{| class="wikitable"
 +
|-
 +
| bgcolor="Gray" | <span style="color: white">Nome servizio</span> || '''GenerateTicket'''
 +
|-
 +
| bgcolor="Gray" | <span style="color: white">Servizio utilizzato da</span> || Fornitori dei sistemi di accesso per ogni company
 +
|}
 +
 +
==== Parametri in ingresso ====
 +
{| class="wikitable"
 +
|-
 +
| colspan="4" bgcolor="LightGrey" style="text-align: center" | <span style="color: white;">Oggetto: GenerateTicket</span>
 +
|- bgcolor="LightGrey" style="text-align: center"
 +
| <span style="color: white;">Parametro</span> || <span style="color: white;">Tipo</span> || <span style="color: white;">Obbligatorio</span> || <span style="color: white">Descrizione</span>
 +
|-
 +
| Group || integer || Si || Codice numerico univoco di identificazione del gruppo
 +
|-
 +
| Company || integer || Si || Codice numerico univoco di identificazione della company a cui viene generato il ticket
 +
|-
 +
| Workstation || integer || Si || Codice numerico univoco della workstation da cui viene generato il ticket
 +
|-
 +
| Creationtime || date || Si || Data e ora di generazione del biglietto
 +
|-
 +
| TicketIdentifier || integer || Si || Codice numerico univoco di identificazione del biglietto
 +
|-
 +
| OpenPassUID || integer || Si || Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass
 +
|-
 +
| RegisterWebSaleId || integer || Si || Codice identificativo univoco della transazione di vendita
 +
|-
 +
| SerialNumberEx2 || integer || Si || Codice numerico univoco di identificazione del biglietto per la cassa in cui viene generato il ticket
 +
|}
 +
 +
==== Parametri in uscita ====
 +
{| class="wikitable"
 +
|-
 +
| colspan="4" bgcolor="SeaGreen" style="text-align: center" | <span style="color: white;">Oggetto: GenerateTicket</span>
 +
|- bgcolor="SeaGreen" style="text-align: center"
 +
| <span style="color: white;">Parametro</span> || <span style="color: white;">Tipo</span> || <span style="color: white">Descrizione</span>
 +
|-
 +
| OpenPassUID || integer || Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass
 +
|}
 +
 
=== (STEP 7) - Lettura generazione tessera ===
 
=== (STEP 7) - Lettura generazione tessera ===
 
I fornitori dei WebShop hanno a disposizione il servizio Web '''getStatusSales''' che dato in ingresso il RegisterWebSaleID restituisce in quale company, data e ora è stato scaricato. In caso la transazione di vendita non fosse ancora stata recuperata da nessun company, il servizio restituisce NULL.
 
I fornitori dei WebShop hanno a disposizione il servizio Web '''getStatusSales''' che dato in ingresso il RegisterWebSaleID restituisce in quale company, data e ora è stato scaricato. In caso la transazione di vendita non fosse ancora stata recuperata da nessun company, il servizio restituisce NULL.

Versione delle 13:56, 15 set 2016

L’attuale sistema OpenPass è stato predisposto per gestire ricarica e vendita online dei titoli di viaggio, per far questo è necessario:

  • Modificare i servizi Web esistenti del server OpenPass:
    • RegisterTicket
    • GetTicket
    • RegisterCustomer
  • Implementare nuovi servizi Web del server OpenPass:
    • RegisterWebSales
    • UpdateWebSalesAmmount
    • GenerateTicket
    • GetWebSales
    • GetPassages
    • SetDailyClosing
    • GetStatusSales
    • GetCustomer
    • Getcustomerstatus
    • Getcustomerdomain
    • CreateDomain
    • RegisterDomain
    • GetDomainList

È stato introdotto il concetto di WebCompany: azienda accreditata OpenPass che fornirà servizio di vendita per le stazioni (company).

È stato introdotto il concetto di WebShop: portale specifico di vendita dei titoli OpenPass per una determinata Company. Una WebCompany può avere uno o più WebShop. Ogni WebShop è legato univocamente alla propria company (stazione). Nel caso di WebShop di comprensorio, una stazione (company) dovrà farsi carico di gestire il WebShop a cui è collegato il comprensorio.

I WebShop inviano al server le transazioni di vendita, che possono avere tre tipi di stato:

  • pay per use; (stazione) - Prezzo standard.
  • ricarica
  • ritiro presso biglietteria di nuova tessera.

Ogni transazione di vendita verrà identificata univocamente attraverso l’identificativo incrementale della tabella delle transazioni chiamato RegisterWebSaleID generato dal server OpenPass.

Più transazioni di vendita possono essere raggruppate da un univo OrderNumber fornito dal WebShop in fase di invio di transazioni.

Ogni transazione di vendita inviata al Server OpenPass da parte del WebShop sarà composta da:

  • Identificativo di transazione RegisterWebSaleID (seriale assegnato dal server OpenPass e chiave univoca della transazione di vendita);
  • Identificativo di ordine OrderNumber' (identificativo gestito dal WebShop);
  • DomainID (Identificativo del Dominio a cui è destinata la transazione di vendita);
  • WebShopID (Identificativo del WebShop che ha generato la vendita);
  • OpenPassUID (OpenPass UID della tessera da ricarica, valorizzato a NULL in caso di ritiro presso la biglietteria);
  • TicketID (identificativo della tipologia di biglietto venduto, recuperata dal server OpenPass attraverso il servizio GetTicket);
  • DataInizioValidità (data e orario di inizio validità del biglietto venduto);
  • CustomerIdentifier (identificativo del soggetto a cui è stato venduto il biglietto, recuperato dal server OpenPass attraveso il servizio GetCustomer);
  • Info (informazione aggiuntiva codificata in base64 gestita tra WebShop e Company);
  • TipoTransazione (0=ritiro, 1=ricarica, 2=registrare rata di denaro, 3=storno),
  • payperuse (0=no pay per use; 1=si pay per use)
  • Insurance Assicurazione (0=no; 1=si)
  • amount (valori in € della transazione di vendita)
  • RecordOpenPass (settore del biglietto firmato alla fonde dal server OpenPass che avrà la sua chiave)
  • Root.Group (Gruppo di appartenenza del server OpenPass)
  • Root.Workstation (Identificativo dell’emettitrice legata al server OpenPass)
  • Root.SerialNumberEx2 (numero seriale del biglietto generato dall’emettitrice legata al server OpenPass)

Ogni transazione di vendita viene scaricata dalla stazione (dominio) a cui è destinata e una volta effettuata la ricarica/consegna della tessera.

I gestori dei sistemi di accesso hanno la possibilità di:

  • caricare il settore firmato dal server OpenPass;
  • generare il settore con i dati della transazione di vendita con una propria Workstation.

In entrambi i casi, la stazione deve comunicare l’avvenuta generazione del biglietto sul supporto inviando i dati al server OpenPass attraverso il servizio sotto illustrato GenerateTicket. Il server OpenPass deve conoscere gli identificativi per rintracciare i passaggi del biglietto nel sistema OpenPass. Gli identificati sono costituiti dalla copia di valori:

  • Root.Workstation (numero identificativo della emittente Workstation nel sistema OpenPass);
  • Root.SerialNumberEx2 (numero seriale interno alla emittente Workstation),

generati dalla workstation del server oppure dalla workstation della stazione.

Vendita e ricarca online delle tessere in formato OpenPass

Per permettere la gestione particolareggiata dei Ticket verrà inserito un TAG aggiuntivo <info></info> nel servizio RegisterTicket, con contenuto serializzato (base64), utilizzabile dal produttore a piacere (Company di vendita). Questo campo conterrà informazioni utili al produttore dei sistemi di accesso e al fornitore del negozio internet (WebShop).

Verrà creato un nuovo servizio RegisterWebSales per inviare le transazioni di vendita effettuate dal un WebShop. Ogni transazione di vendita verrà identificata univocamente dal proprio seriale di vendita RegisterWebSaleID fornito dal server OpenPass.

Verrà creato un nuovo servizio UpdateWebSales per aggiornare le vendite Web con il quantitativo economico derivato dal calcolo dell'uso.

Verrà creato un nuovo servizio GetWebSales con cui i fornitori dei sistemi di accesso potranno scaricare dal server OpenPass tutte le vendite Web effettuate per ogni dominio.

Verrà creato un nuovo servizio GenerateTicket con cui i fornitori dei sistemi di accesso potranno inviare al Server OpenPass la Root.Workstation e Root.SerialNumberEx2 con cui è stato generato il biglietto per ogni specifica transazione di vendita identificata con RegisterWebSaleID. Verrà creato un nuovo servizio GetPassages per recuperare tutti i passaggi effettuati da una tessera ricaricata a seguito di una vendita online identificata con RegisterWebSaleID.

Verrà creato un nuovo servizio SetDailyClosing per inviare al server OpenPass lo stato di chiusura di una stazione indicante che tutti i passaggi sono stati inviati al server. Tale informazione sarà utile al fornitore di WebShop in quanto potrà da quel momento calcolare gli usi delle tessere ricaricate.

Gli step per giungere alla ricarica dei titoli di viaggio attraverso internet prevedono i seguenti passi:

(STEP 1) - Codifica Ticket

Le stazioni (Company) inviano al Server OpenPass i biglietti (ticket) vendibili attraverso il servizio già attivo (RegisterTicket) che verrà esteso con il tag aggiuntivo <info>

Nome servizio RegisterTicket
Servizio utilizzato da Fornitori dei sistemi di accesso per ogni company

Parametri in ingresso

Oggetto: RegisterTicket
Parametro Tipo Obbligatorio Descrizione
Description text Si Descrizione del ticket
CustomerAge integer Si Classe di età del destinatario del biglietto (1=”Bambini <=11”, 2=”Ragazzi 12-17”, 3=”Adulti 18-64”, 4=”Senior >= 65”)
CustomerType integer No Tipologia del destinatario del biglietto (1="Non residenti", 2="Residenti")
Info text No Informazione aggiuntiva codificata in Base64 gestita tra WebShop e Company
Values OBJ Si Oggetto contenente i TokenValue
Oggetto: Values
Parametro Tipo Obbligatorio Descrizione
TokenValue OBJ Si Oggetto che contiene i dati dei token
Oggetto: TokenValue
Parametro Tipo Obbligatorio Descrizione
Name text Si Nome del token. (Il Token “Root.TicketID” è obbligatorio)
Value text Si Valore del token. (Il Token “Root.TicketID” è obbligatorio)

Parametri in uscita

Oggetto: RegisterTicketResult
Parametro Tipo Descrizione
TicketIdentifier integer Codice numerico univoco di identificazione del biglietto. Il codice restituito sarà quello che viene passato con il Token “Root.TicketID”

(STEP 2) - Lettura Ticket

Le WebCompany fornitori di Webshop leggono i biglietti (ticket) dal Server OpenPass con il servizio esistente GetTicket che verrà ampliato con l'informazione del tag aggiuntivo <info>

Nome servizio GetTicket
Servizio utilizzato da WebCompany

Parametri in ingresso

Oggetto: GetTicket
Parametro Tipo Obbligatorio Descrizione
TicketIdentifier integer Si Codice numerico univoco di identificazione del biglietto
Company integer Si Codice numerico univoco identificativo della stazione

Parametri in uscita

Oggetto: GetTicket
Parametro Tipo Descrizione
Identifier integer Codice numerico univoco di identificazione del biglietto
Description text Descrizione del biglietto
CustomerAge integer Classe di età del destinatario del biglietto (1=”Bambini <=11”, 2=”Ragazzi 12-17”, 3=”Adulti 18-64”, 4=”Senior >=65”)
CustomerType integer Tipologia del destinatario del biglietto (1="Non residenti", 2="Residenti")
LastTouch dateTime Data e ora di creazione
Info text Informazione aggiuntiva codificata in Base64 gestita tra WebShop e Company
Values OBJ Oggetto contenente i TokenValue
Oggetto: GetTicket
Parametro Tipo Descrizione
TokenValue OBJ Oggetto che contiene i dati dei token
Oggetto: GetTicket
Parametro Tipo Descrizione
Name text Nome del token
Value text Valore del token

(STEP 3) - Codifica Customer

  • Codice numerico univoco di identificazione del customer [*]
  • Dominio di ultima vendita (ricavato dal server) [*]
  • openpassuid
  • nome del customer [*]
  • cognome del custorm [*]
  • titolo del customer
  • data di nascita del customer [*]
  • sesso del customer
  • codice fiscale del customer
  • lavoro del customer
  • email del customer
  • Sociale del customer
  • Cellulare del customer
  • Telefono fisso del customer
  • indirizzo del customer
  • C.A.P. del customer
  • Città del customer
  • Provincia del customer
  • Nazione del customer
  • Note
  • Consenso per la divulgazione dei dati personali verso terzi
  • Fotografia (limitare dimensioni 100k e rapporto immagine definito (360x480) 50k
  • Data ripresa foto
  • Data e ora di fine validità dei dati relativi al customer
  • LogTime: data o ora di inserimento all’interno del database OpenPass

Il server OpenPass registrerà la data e l’ora corrente al momento della registrazione dei dati del customer all’interno del database (LogTime).

Prima di inviare i dati del customer il WebShop potrà verificare la base dati sul serve rOpenPass per ereditare i dati aggiornati del customer attraverso i servizi GetCustomersStatus, GetCustomersDomain, GetCustomer

  • GetCustomersStatus: è il servizio Web che restituisce l’ultima data di aggiornamento dei customers collegati ad un determinato dominio.
  • GetCustomersDomain: è il servizio Web che restituisce i dati di tutti i customers aggiornati da una certa data in poi e che hanno acquistato almeno una volta un ticket in un determinato domain
  • GetCustomer: è il servizio Web che restituisce tutti i dati del customer relativi ad uno specifico CustomerIdentifier

Register Customer

Nome servizio RegisterCustomer
Servizio utilizzato da Fornitori dei sistemi di accesso per ogni company, WebCompany
Parametri in ingresso
Oggetto: RegisterCustomer
Parametro Tipo Obbligatorio Descrizione
CustomerIdentifier integer Si Codice numerico univoco di identificazione del customer
Domain integer Si Codice numerico univoco di identificazione del dominio
OpenPassUID text No Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass
Name text Si Nome del customer
Surname text Si Cognome del customer
BirthDate date Si Data di nascita del customer
Sex text No Sesso del customer
CFCode text No Codice fiscale del customer
Job text No Occupazione del customer
Email text No Indirizzo email del customer
Social text No Sociale del customer
Cellular text No Numero di cellulare del customer
Phone text No Numero di telefono del customer
Adress text No Indirizzo del customer
PostCode text No CAP del customer
City text No Città del customer
State text No Provincia del customer
Country text No Nazione del customer
Note text No Note
Privacy boolean No Booleano che indica se è stato compilato il modulo per la divulgazione dei dati personali verso terzi
JPGImage text No Immagine codificata in Base64
DateJPGImage date No Data dell'immagine
RecordExpiry Date No Data di fine validità del record
Parametri in uscita
Oggetto: RegisterCustomer
Parametro Tipo Descrizione
CustomerIdentifier integer Codice numerico univoco di identificazione del cliente
CreatedNew boolean Booleano che indica se il nuovo cliente è stato aggiunto
LogTime dateTime Data e ora di inserimento/variazione del customer

GetCustomersStatus

Nome servizio GetCustomerStatus
Servizio utilizzato da WebCompany
Parametri in ingresso
Oggetto: GetCustomerStatus
Parametro Tipo Obbligatorio Descrizione
Domain integer Si Codice numerico univoco di identificazione del dominio
Parametri in uscita
Oggetto: RegisterCustomer
Parametro Tipo Descrizione
Domain integer Codice numerico univoco di identificazione del cliente
LogTime dateTime Ultima data di aggiornamento dei customers collegati al dominio passato in ingresso

GetCustomersDomain

Nome servizio GetCustomerDomain
Servizio utilizzato da WebCompany
Parametri in ingresso
Oggetto: GetCustomerDomain
Parametro Tipo Obbligatorio Descrizione
Domain integer Si Codice numerico univoco di identificazione del dominio
LogTime dateTime Si Data di aggiornamento dei customers collegati al dominio
Parametri in uscita
Oggetto: GetCustomerDomain
Parametro Tipo Descrizione
Customer OBJ Oggetto che contiene i dati dei customers aggioranati da una certa data in poi
Oggetto: Customers
Parametro Tipo Descrizione
CustomerIdentifier integer Codice numerico univoco di identificazione del customer
Domain integer Codice numerico univoco di identificazione del dominio
OpenPassUID text Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass
Name text Nome del customer
Surname text Cognome del customer
BirthDate date Data di nascita del customer
Sex text Sesso del customer
CFCode text Codice fiscale del customer
Job text Occupazione del customer
Email text Indirizzo email del customer
Social text Sociale del customer
Cellular text Numero di cellulare del customer
Phone text Numero di telefono del customer
Adress text Indirizzo del customer
PostCode text CAP del customer
City text Città del customer
State text Provincia del customer
Country text Nazione del customer
Note text Note
Privacy boolean Booleano che indica se è stato compilato il modulo per la divulgazione dei dati personali verso terzi
JPGImage text Immagine codificata in Base64
DateJPGImage date Data dell'immagine
RecordExpiry date Data di fine validità del record
LogTime dateTime Data e ora di modifica del customer

GetCustomer

Nome servizio GetCustomer
Servizio utilizzato da Fornitori dei sistemi di accesso per ogni company, WebCompany
Parametri in ingresso
Oggetto: GetCustomer
Parametro Tipo Obbligatorio Descrizione
CustomerIdentifier integer Si Codice numerico univoco di identificazione del customer
Parametri in uscita
Oggetto: RegisterCustomer
Parametro Tipo Descrizione
CustomerIdentifier integer Codice numerico univoco di identificazione del customer
Domain integer Codice numerico univoco di identificazione del dominio
OpenPassUID text Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass
Name text Nome del customer
Surname text Cognome del customer
BirthDate date Data di nascita del customer
Sex text Sesso del customer
CFCode text Codice fiscale del customer
Job text Occupazione del customer
Email text Indirizzo email del customer
Social text Sociale del customer
Cellular text Numero di cellulare del customer
Phone text Numero di telefono del customer
Adress text Indirizzo del customer
PostCode text CAP del customer
City text Città del customer
State text Provincia del customer
Country text Nazione del customer
Note text Note
Privacy boolean Booleano che indica se è stato compilato il modulo per la divulgazione dei dati personali verso terzi
JPGImage text Immagine codificata in Base64
DateJPGImage date Data dell'immagine
RecordExpiry date Data di fine validità del record
LogTime date Data e ora di modifica del customer

(STEP 4) - Codifica WebSales

I fornitori di WebShop inviano gli acquisti effettuali dai clienti. Verrà creato un nuovo servizio RegisterWebSales che prevederà l’invio di:

  • OrderNumber: numero d’ordine della transazione di vendita;
  • Domain: dominio interessato alla transazione di vendita;
  • Openpassuid: numero univoco della tessera RFID come definito dal formato OpenPass
  • TicketIdentifier: identificativo univoco del tipo di biglietto interessato dalla transizione di vendita;
  • StartDate: data di inizio validità della transazione di vendita oltre la quale è possibile creare il biglietto
  • CustomerIdentifier: identificativo univoco del cliente sul server OpenPass
  • Info: informazione aggiuntiva codificata in base64 gestita tra WebShop e Company
  • OperationType: (0=ritiro, 1=ricarica, 2=registrare rata di denaro, 3=storno)
  • Payperuse: (0=no payperuse, 1=si payperuse)
  • Insurance: abbinata una assicurazione (0=no, 1=si)
  • CardPaid: inclusa la card nella transizione di vendita (0=no, 1=si)
  • Ammount: valore della transazione di vendita

Il servizio risponderà con il valore di RegisterWebSaleID (seriale di vendita) per ciascuna vendita.

Nome servizio RegisterWebSales
Servizio utilizzato da WebCompany

Parametri in ingresso

Oggetto: RegisterWebSales
Parametro Tipo Obbligatorio Descrizione
OrderNumber integer Si Numero d'ordine della transazione di vendita
Domain integer Si Dominio interessato alla transazione di vendita
OpenPassuuid integer No Numero univoco della tessera RFID come definito dal formato OpenPass. Se non passato il valore viene registrato cone NULL
TicketIdentifier integer Si Identificativo univoco del tipo di biglietto interessato dalla transizione di vendita
StarDate date No Data di inizio validità della transazione di vendita oltre la quale è possibile creare il biglietto. Se non passato il valore viene registrato a NOW (data di registrazione).
CustomerIdentifier integer Si Identificativo univoco del cliente sul server OpenPass. Per i biglietti non nominativi inserire il valore 0
Info text No Informazione aggiuntiva codificata in Base64 gestita tra WebShop e Company
OperationType integer Si 0-ritiro, 1 ricarica, 2 registrare rata di denaro, 3 storno
Payperuser boolean No 0 = no payperuse, 1 = si payperuse. Se non passato il valore viene registrato come 0
Insurance boolean No Abbinata un assicurazione (0 = no, 1 = si). Se non passato il valore viene registrato come 0
CardPaid boolean No Inclusa la card nella transazione di vendita (0=no, 1=si). Se non passato il valore viene registrato come 0
Ammount decimal signed No Valore della transazione di vendita.
Il valore viene espresso in euro. Il separatore dei decimali è la virgola. La parte decimale è composta da due cifre. La parte intera è composta al massimo da N 5 cifre. Non è previsto un separatore per le migliaia.
Il valore può essere negativo per gli storni.

Parametri in uscita

Oggetto: RegisterWebSales
Parametro Tipo Descrizione
RegisterWebSaleID integer Seriale di vendita

(STEP 5) - Lettura WebSales (per dominio)

Le stazioni, attraverso i fornitori dei sistemi di accesso, leggono dal Server OpenPass le WebSales inviate dai fornitori di WebShop attraverso il nuovo servizio GetWebSales.

Il servizio viene interrogato passando l’identificativo della Company (identificativo della stazione) e l'ultimo RegisterWebSaleID in possesso dalla stazione.

Il servizio restituisce le informazioni di tutte le transazioni di vendita successive al RegisterWebSaleID passato, relativi a tutti i domini a cui è associata la Company richiesta.

In tali informazioni sono presenti gli OpenPassUID che identificano le tessere da ricaricare e i RegisterWebSaleID che permettono di legare le vendite WEB alle tessere ricaricate dai tornelli. Verrà passato anche il setore OpenPass generato dalla workstation del server OpenPass con la propria chiave:

  • RecordOpenPass: contenuto in Base64 del settore del biglietto firmato alla fonte del server OpenPass che avrà la sua chiave
  • Root.Group: gruppo di appartenenza del server OpenPass
  • Root.Workstation: identificativo dell’emettitrice legata al server OpenPass
  • Root.SerialNumberEx2: numero seriale del biglietto generato dall’emettitrice legata al server OpenPass
Nome servizio GetWebSales
Servizio utilizzato da WebCompany

Parametri in ingresso

Oggetto: GetWebSales
Parametro Tipo Obbligatorio Descrizione
Company integer Si Identificativo della company
RegisterWebSaleID integer Si Seriale di vendita

Parametri in uscita

Oggetto: GetWebSales
Parametro Tipo Descrizione
ArrayWebSales array Array di oggetti di tipo WebSales
Oggetto: WebSales
Parametro Tipo Descrizione
RegisterWebSaleID integer Seriale di vendita
OrderNumber integer Numero d’ordine della transazione di vendita
Domain integer Dominio interessato alla transazione di vendita
Openpassuid integer Numero univoco della tessera RFID come definito dal formato OpenPass
TicketIdentifier integer Identificativo univoco del tipo di biglietto interessato dalla transizione di vendita
StartDate date Data di inizio validità della transazione di vendita oltre la quale è possibile creare il biglietto
CustomerIdentifier integer Identificativo univoco del cliente sul server OpenPass
Info text Informazione aggiuntiva codificata in base64 gestita tra WebShop e Company
OperationType integer 0-ritiro, 1 ricarica, 2 registrare rata di denaro, 3 storno
Payperuse boolean 0 = no peyperuse, 1 = si payperuse.
Insurance boolean Abbinata un assicurazione (0 = no, 1 = si)
CardPaid boolean Inclusa la card nella transazione di vendita (0 = no, 1 = si)
Ammount decimal signed Valore della transazione di vendita
RecordOpenPass text Contenuto in Base64 del settore del biglietto firmato alla fonte dal server OpenPass che avrà la sua chiave
Root.Group integer Gruppo di appartenenza del server OpenPass
Root.Workstation integer Identifitivo dell'emettitrice legata al server OpenPass
Root.SerialNumberEx2 integer Numero seriale del biglietto generato dall’emettitrice legata al server OpenPass

(STEP 6) - Generazione della tessere relativa alla vendita

Ricevute la transazioni di vendita relative a tutti i domini della specifica company, i fornitori dei sistemi di accesso, sono in grado di generare i biglietti:

  • emettere dalle emettitrici i nuovi biglietti
  • ricaricare alle antenne le tessere in formato OpenPass.

Successivamente a tali azioni, i fornitori dei sistemi di accesso, dovranno utilizzare il nuovo servizio GenerateTicket per inviare al Server OpenPass i token Root.Workstation, Root.SerialNumberEx2 e la data di creazione della tessera con cui è stato generato il biglietto per ogni specifica transazione di vendita identificata con RegisterWebSaleID.

I dati inviati dai fornitori dei sistemi di accesso, successivamente alla generazione della tessera contnenete la transazione di vendita sono:

  • Group
  • Company
  • Workstation
  • Creationtime
  • Ticketidentifier
  • OpenPassUID
  • RegisterWebSaleID
  • SerialNumberEx2
Nome servizio GenerateTicket
Servizio utilizzato da Fornitori dei sistemi di accesso per ogni company

Parametri in ingresso

Oggetto: GenerateTicket
Parametro Tipo Obbligatorio Descrizione
Group integer Si Codice numerico univoco di identificazione del gruppo
Company integer Si Codice numerico univoco di identificazione della company a cui viene generato il ticket
Workstation integer Si Codice numerico univoco della workstation da cui viene generato il ticket
Creationtime date Si Data e ora di generazione del biglietto
TicketIdentifier integer Si Codice numerico univoco di identificazione del biglietto
OpenPassUID integer Si Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass
RegisterWebSaleId integer Si Codice identificativo univoco della transazione di vendita
SerialNumberEx2 integer Si Codice numerico univoco di identificazione del biglietto per la cassa in cui viene generato il ticket

Parametri in uscita

Oggetto: GenerateTicket
Parametro Tipo Descrizione
OpenPassUID integer Codice identificativo univoco della tessera RFID come definito dalle specifiche del formato OpenPass

(STEP 7) - Lettura generazione tessera

I fornitori dei WebShop hanno a disposizione il servizio Web getStatusSales che dato in ingresso il RegisterWebSaleID restituisce in quale company, data e ora è stato scaricato. In caso la transazione di vendita non fosse ancora stata recuperata da nessun company, il servizio restituisce NULL.

Nome servizio getStatusSales
Servizio utilizzato da Fornitori di WebShop

Parametri in ingresso

Oggetto: getStatusSales
Parametro Tipo Obbligatorio Descrizione
RegisterWebSaleID integer Si Seriale di vendita

Parametri in uscita

Oggetto: getStatusSales
Parametro Tipo Descrizione
Company integer Identificativo della company
Creationtime dateTime Orario e data generazione della tessera

(STEP 8) - Invio dei passaggi

Le stazioni inviano i passaggi effettuati dalle tessere ricaricate utilizzando il servizio già attivo Registerpassages

(STEP 9) - Chiusura giornata

Al termine dell'invio di tutti i passaggi della giornata, la stazione (company) deve inviare la chiusura, in modo da consentire al WebShop di scaricare i passaggi di ogni RegisterSaleID e calcolare l'ammontare della vendita. Tale azione avviene invocando un nuovo servizio SetDailyClosing inviando l’identificativo della company e la data e ora di chiusura.

Nome servizio SetDailyClosing
Servizio utilizzato da Fornitori di WebShop

Parametri in ingresso

Oggetto: SetDailyClosing
Parametro Tipo Obbligatorio Descrizione
Company integer Si Identificativo della company
ClosingDatetime dateTime Si Data ed orario di chiusura della company

Parametri in usita

Oggetto: SetDailyClosing
Parametro Tipo Descrizione
LogTime dateTime Data e orario della modifica

(STEP 10) - Lettura passaggi

A chiusura di giornata effettuata i fornitori di WebShop interrogano il server OpenPass per leggere tutti i passaggi effettuati da ciascuna RegisterSaleID e calcolare l'ammontare della vendita. Tale azione avviene invocando un nuovo servizio GetPassages inviando RegisterSaleID e giorno (data giorno).

Nome servizio GetPassages
Servizio utilizzato da Fornitori di WebShop

Parametri in ingresso

Oggetto: GetPassages
Parametro Tipo Obbligatorio Descrizione
RegisterSaleID integer Si Seriale di vendita
Date date Si Data dei passaggi

Parametri in uscita

Oggetto: GetPassages
Parametro Tipo Descrizione
LogTime dateTime Data e orario della modifica

(STEP 11) - Registrazione ammontare valori ricarica

A chiusura di giornata effettuata i fornitori di WebShop invieranno al server OpenPass i valori degli ammontare di vendita delle tessere in payperuse. Tale azione avviene invocando un nuovo servizio UpdateWebSalesAmmount inviando per ciascun RegisterSaleID:

  • Ammount: valore della transazione di vendita
  • Description: testo che indica se è stato addebitato un giornaliero, pomeridiano, mattutino, ecc…
  • ReferenceDate: indica a che data è riferita la vendita (giorno in cui sono stati effettuati i passaggi)
  • Domain: indica su quale dominiio è stato calcolato l’ammontare
Nome servizio UpdateWebSalesAmmount
Servizio utilizzato da Fornitori di WebShop
Parametri in ingresso
Oggetto: RegisterCustomer
Parametro Tipo Obbligatorio Descrizione
RegisterWebSaleID integer Si Seriale di vendita
Ammount decimal signed Si Valore della transazione di vendita.
Il valore viene espresso in euro. Il separatore dei decimali è la virgola. La parte decimale è composta da due cifre. La parte intera è composta al massimo da N 5 cifre. Non è previsto un separatore per le migliaia.
Il valore può essere negativo per gli storni.
Description text Testo che indica se è stato addebitato un giornaliero, pomeridiano, mattutino, ecc
ReferenceDate date Indica a che data è riferita la vendita dell'addebito
Domain integer Indica su quale dominio è stato calcolato l'ammontare
Parametri in uscita
Oggetto: RegisterCustomer
Parametro Tipo Descrizione
LogTime dateTime Data e ora della modifica

Servizi Web relativi ai domini

Create Domain

Register Domain

Get Domain List

Estratto da "http://librobianco.openpass.it/index.php?title=Vendita_e_ricarica_online_del_titolo_di_viaggio&oldid=219"