Differenze tra le versioni di "Appendice A"

Da Libro Bianco OpenPass.
[versione verificata][versione verificata]
(→‎Servizi del Formato 3: : aggiunto link di rimando a pagina specifica per ciascun WS)
(Rimozione tabelle per Servizi del Formato 3)
Riga 3: Riga 3:
 
=== LOGIN ===
 
=== LOGIN ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_Login|Web Service: Login]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_Login|Web Service: Login]]
−
 
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Username || testo || si || Username della stazione
 
−
|-
 
−
| Password || testo || si || Password della stazione
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Group|| numerico || Codice univoco di identificazione del gruppo
 
−
|-
 
−
| Company|| numerico || Codice univoco di identificazione del gruppo
 
−
|}
 
  
 
=== REGISTERTOKEN ===
 
=== REGISTERTOKEN ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterToken|Web Service: RegisterToken]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterToken|Web Service: RegisterToken]]
−
 
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Name|| testo || si || Nome del token
 
−
|-
 
−
| Description || testo || si || Descrizione del significato di token
 
−
|-
 
−
| Type || numerico || si || Tipo assegnato (0=numerico, 1=data, 2=ora)
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| CreatedNew|| boolean|| Booleano che indica se il token è stato aggiunto
 
−
|}
 
  
 
=== REGISTERFORMAT ===
 
=== REGISTERFORMAT ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterFormat|Web Service: RegisterFormat]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterFormat|Web Service: RegisterFormat]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Description || testo || si || Descrizione del formato
 
−
|-
 
−
| Creator || testo || si || Nome del creatore del formato
 
−
|-
 
−
| Fixed area || oggetto || no || Oggetto contenente gli oggetti TokenAllocation della fixed area
 
−
|-
 
−
| Variable area || oggetto || no || Oggetto contenente gli oggetti TokenAllocation della variable area
 
−
|}
 
−
===== Oggetto Fixed area =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| TokenAllocation || oggetto || si || Oggetto contenente i valori dei Token
 
−
|}
 
−
===== Oggetto Variable area =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| TokenAllocation || oggetto || si || Oggetto contenente i valori dei Token
 
−
|}
 
−
===== Oggetto TokenAllocation =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Name || testo || si || Nome del Token precedentemente salvato
 
−
|-
 
−
| BitAdress || numerico || no || BitAdreass
 
−
|-
 
−
| BitWidth || numerico || no || BitWidth
 
−
|-
 
−
| ConstantValue || numerico || no || ConstantValue
 
−
|}
 
−
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| FormatIdentifier || numerico || Codice numerico univoco di identificazione del formato
 
−
|-
 
−
|}
 
 
=== ENUMERATEFORMATS ===
 
=== ENUMERATEFORMATS ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateFormats|Web Service: EnumerateFormats]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateFormats|Web Service: EnumerateFormats]]
  
−
==== Parametri input ====
 
−
Nessuno
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| FormatIdentifiers || oggetto || Lista dei codici identificativi dei formati noti al server
 
−
|}
 
−
===== Oggetto FormatIdentifiers =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Int || numerico || Codice numerico univoco di identificazione dei formati noti al server
 
−
|}
 
 
=== GETFORMAT ===
 
=== GETFORMAT ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_GetFormat|Web Service: GetFormat]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_GetFormat|Web Service: GetFormat]]
−
==== Parametri input ====
+
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| FormatIdentifier || numerico || si || Codice numerico univoco di identificazione del formato
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Identifier || numerico || Codice numerico univoco di identificazione del formato
 
−
|-
 
−
| Description || testo || Descrizione del formato
 
−
|-
 
−
| Creator || testo || Nome del creatore del formato
 
−
|-
 
−
| LastTouch || data || Data e ora di creazione
 
−
|-
 
−
| Fixed area || oggetto || Oggetto contenente gli oggetti token allocation della fixed area
 
−
|-
 
−
| Variable area || oggetto || Oggetto contenente gli oggetti toke allocation della variable area
 
−
|}
 
−
===== Oggetto Fixed area =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| TokenAllocation || oggetto || Oggetto contenente i valori dei Token
 
−
|}
 
−
===== Oggetto Variable area =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| TokenAllocation || oggetto || Oggetto contenente i valori dei Token
 
−
|}
 
−
===== Oggetto TokenAllocation  =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Name || testo || Nome del Token precedentemente salvato
 
−
|-
 
−
| BitAdress || numerico || BitAdress
 
−
|-
 
−
| BitWidth || numerico || BitWidth
 
−
|-
 
−
| ConstantValue || numerico || ConstantValue
 
−
|}
 
 
=== REGISTERTICKET ===
 
=== REGISTERTICKET ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterTicket|Web Service: RegisterTicket]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterTicket|Web Service: RegisterTicket]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Description || testo || si || Descrizione del ticket
 
−
|-
 
−
| CustomerAge || numerico || si || Classe di età del destinatario del biglietto (1=”Bambini <=11”, 2=”Ragazzi 12-17”, 3=”Adulti 18-64”, 4=”Senior >= 65”)
 
−
|-
 
−
| CustomerType || numerico || no || Tipologia del destinatario del biglietto (1=”Non Residenti”, 2=”Residenti”)
 
−
|-
 
−
| Values || oggetto || si || oggetto contenente i TokenValue
 
−
|}
 
−
===== Oggetto Values =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| TokenValue || oggetto || si || Oggetto che contiene i dati dei token
 
−
|}
 
−
===== Oggetto TokenValue =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Name || testo || si || Nome del token. (Il Token “Root.TicketID” è obbligatorio)
 
−
|-
 
−
| Value || testo || si || Valore del token. (Il valore del Token “Root.TicketID” è obbligatorio)
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| TicketIdentifier || numerico || Codice numerico univoco di identificazione del biglietto. Il codice restituito sarà quello che viene passato con il Token “Root. TicketID”
 
−
|}
 
 
=== ENUMERATETICKETS ===
 
=== ENUMERATETICKETS ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateTickets|Web Service: EnumerateTickets]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateTickets|Web Service: EnumerateTickets]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Company || numerico || si || Codice numerico univico di identificazione della stazione
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| TicketIdentifiers || oggetto || Lista dei codici identificativi dei ticket noti al server
 
−
|}
 
−
===== Oggetto TicketIdentifiers =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Int || numerico || Codice numerico univoco di identificazione dei ticket noti al server
 
−
|}
 
 
=== GETTICKET ===
 
=== GETTICKET ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_GetTicket|Web Service: GetTicket]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_GetTicket|Web Service: GetTicket]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Company || numerico || si || Codice numerico univoco di identificazione della stazione
 
−
|-
 
−
| TicketIdentifier || numerico || si || Codice numerico univoco di identificazione del biglietto
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Identifier || numerico || Codice numerico univoco di identificazione del biglietto
 
−
|-
 
−
| Description || testo || Descrizione del biglietto
 
−
|-
 
−
| CustomerAge || numerico || Classe di età del destinatario del biglietto (1=”Bambini <=11”, 2=”Ragazzi 12-17”, 3=”Adulti 18-64”, 4=”Senior >= 65”)
 
−
|-
 
−
| CustomerType || numerico || Tipologia del destinatario del biglietto (1=”Non Residenti”, 2=”Residenti”)
 
−
|-
 
−
| LastTouch || data || Data e ora di creazione
 
−
|-
 
−
| Values || oggetto || Oggetto contenente i TokenValue
 
−
|}
 
−
===== Oggetto Values =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| TokenValue || oggetto || Oggetto che contiene i dati dei token
 
−
|}
 
−
===== Oggetto TokenValue =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Name || testo || Nome del token
 
−
|-
 
−
| Value || testo || Valore del token
 
−
|}
 
 
=== ENUMERATEGROUPS ===
 
=== ENUMERATEGROUPS ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateGroups|Web Service: EnumerateGroups]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateGroups|Web Service: EnumerateGroups]]
  
−
==== Parametri input ====
 
−
Nessuno
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| GroupIdentifies || oggetto || Lista dei codici identificativi dei gruppi noti al server
 
−
|}
 
−
===== Oggetto GroupIdentifies =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Int || numerico || Codice numerico univoco di identificazione dei gruppi noti al server
 
−
|}
 
 
=== ENUMERATECOMPANIES ===
 
=== ENUMERATECOMPANIES ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateCompanies|Web Service: EnumerateCompanies]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateCompanies|Web Service: EnumerateCompanies]]
−
==== Parametri input ====
+
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del gruppo
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Companies || oggetto || Lista dei codici identificativi delle stazioni appartenenti al gruppo
 
−
|}
 
−
===== Oggetto Companies =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Int || numerico || Codice numerico univoco di identificazione delle stazioni note al server
 
−
|}
 
 
=== ENUMERATEWORKSTATIONS ===
 
=== ENUMERATEWORKSTATIONS ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateWorkstations|Web Service: EnumerateWorkstations]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateWorkstations|Web Service: EnumerateWorkstations]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Company || numerico || si || Codice numerico univoco di identificazione della stazione
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Workstations || oggetto || Lista dei codici identificativi delle workstations appartenenti alla stazione
 
−
|}
 
−
===== Oggetto Workstation =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Int || numerico || Codice numerico univoco di identificazione delle workstations note al server
 
−
|}
 
 
=== REGISTERWORKSTATIONKEY ===
 
=== REGISTERWORKSTATIONKEY ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterWorkstationKey|Web Service: RegisterWorkstationKey]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterWorkstationKey|Web Service: RegisterWorkstationKey]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del group
 
−
|-
 
−
| Company || numerico || si || Codice numerico univoco di identificazione della stazione
 
−
|-
 
−
| Workstation || numerico || si || Codice numerico univoco di identificazione della workstation
 
−
|-
 
−
| KeyIdentifier || numerico || si || Codice di identificazione della chiave
 
−
|-
 
−
| Expiri || data || si || Data di fine validità della chiave
 
−
|-
 
−
| KeyLength || numerico || si || Lunghezza della chiave
 
−
|-
 
−
| Modulus || testo || si || Modulo della chiave
 
−
|-
 
−
| Exponent|| testo || si || Esponente della chiave
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| CreatedNew || boolean || Booleano che indica se la chiave è stata aggiunta
 
−
|}
 
 
=== ENUMERATEKEYS ===
 
=== ENUMERATEKEYS ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateKeys|Web Service: EnumerateKeys]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_EnumerateKeys|Web Service: EnumerateKeys]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del gruppo
 
−
|-
 
−
| Workstation || numerico || si || Codice numerico univoco di identificazione della workstation
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| KeyIdentifiers || oggetto || Lista dei codici identificativi delle chiavi appartenenti alle workstation
 
−
|}
 
−
===== Oggetto KeyIdentifiers =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Int || numerico || Codice numerico univoco di identificazione delle chiavi
 
−
|}
 
 
=== GETKEY ===
 
=== GETKEY ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_GetKey|Web Service: GetKey]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_GetKey|Web Service: GetKey]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del group
 
−
|-
 
−
| Workstation || numerico || si || Codice numerico univoco di identificazione della workstation
 
−
|-
 
−
| KeyIdentifier || numerico || si || Codice di identificazione della chiave richiesta
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| Group || numerico || Codice numerico univoco di identificazione del group
 
−
|-
 
−
| Company|| numerico || Codice numerico univoco di identificazione della stazione
 
−
|-
 
−
| Workstation || numerico || Codice numerico univoco di identificazione della workstation
 
−
|-
 
−
| KeyIdentifier || numerico || Codice di identificazione della chiave
 
−
|-
 
−
| Expiri || data || Data di fine validità della chiave
 
−
|-
 
−
| KeyLength || numerico || Lunghezza della chiave
 
−
|-
 
−
| Modulus || testo || Modulo della chiave
 
−
|-
 
−
| Exponent || testo || Esponente della chiave
 
−
|}
 
 
=== REGISTERCUSTOMER ===
 
=== REGISTERCUSTOMER ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterCustomer|Web Service: RegisterCustomer]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterCustomer|Web Service: RegisterCustomer]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Paramentro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Name || numerico || si || Nome del cliente
 
−
|-
 
−
| Name || numerico || si || Numero cliente attribuito localmente dalle casse emittenti
 
−
|-
 
−
| Name || numerico || no || CRSIdentifier
 
−
|-
 
−
| Name || testo || no || CRSData
 
−
|-
 
−
| Name || testo || no || Info1
 
−
|-
 
−
| Name || testo || no || Info2
 
−
|-
 
−
| Name || numerico || no || Codice Postale
 
−
|-
 
−
| Name || testo || no || Immagine
 
−
|-
 
−
| Name || data || no || Data di fine validità del record
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Paramentro !! Tipo !! Descrizione
 
−
|-
 
−
| CustomerIdentifier || numerico || Codic enumerico univoco di identificazione del cliente identico al codice attribuito localmente dalle casse emittenti
 
−
|-
 
−
| CreatedNew || boolean || Booleano che indica se il nuovo cliente è stato aggiunto
 
−
|}
 
 
=== REGISTERSALES ===
 
=== REGISTERSALES ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterSales|Web Service: RegisterSales]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterSales|Web Service: RegisterSales]]
  
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del gruppo
 
−
|-
 
−
| Company || numerico || si || Codice numerico di identificazione della stazione
 
−
|-
 
−
| Sales || oggetto || si || Oggetto che contiene i SaleTransaction
 
−
|}
 
−
===== Oggetto Sales =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| SaleTransaction || oggetto || si || Oggetto che contiene i dati delle vendite
 
−
|}
 
−
===== Oggetto SaleTransaction =====
 
−
{| class="wikitable"
 
−
! Paramentro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Workstation || numerico || si || Codice numerico univoco di identificazione della workstation
 
−
|-
 
−
| OperationType || numerico || si || Specifica il tipo di operazione (0=vendite, 1=annullamenti)
 
−
|-
 
−
| CreationTime || data || si || Data e ora di creazione e vendita del biglietto
 
−
|-
 
−
| Amount || numerico || si || Prezzo
 
−
|-
 
−
| CustomerIdentifier || numerico || si || Identificativo del cliente ottenuto registrando il cliente con il servizio RegisterCustomer (0 per biglietti non nominativi)
 
−
|-
 
−
| TicketIdentifier || numerico || si || Codice identificativo univoco del biglietto
 
−
|-
 
−
| ChipID || testo || no || ChipID dei dati di vendita
 
−
|-
 
−
| Values || oggetto || si || Oggetto che contiene i TokenValue
 
−
|}
 
−
===== Oggetto Values =====
 
−
{| class="wikitable"
 
−
! Paramentro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| TokenValue || oggetto || si || Oggetto che contiene i dati dei token
 
−
|}
 
−
===== Oggetto TokenValue =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Name || testo || si || Nome del token
 
−
|-
 
−
| Value || testo || si || Valore del token
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Paramentro !! Tipo !! Descrizione
 
−
|-
 
−
| InsertedRecordsCount || numerico || Numero dei record effettivamente inseriti
 
−
|}
 
 
=== REGISTERPASSAGES ===
 
=== REGISTERPASSAGES ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterPassages|Web Service: RegisterPassages]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_RegisterPassages|Web Service: RegisterPassages]]
−
+
 
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del gruppo
 
−
|-
 
−
| Company || numerico || si || Codice numerico univoco di identificazione del gruppo
 
−
|-
 
−
| Passages || oggetto || si || Oggetto che contiene i PassageTransaction
 
−
|}
 
−
===== Oggetto Passages =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| PassageTransaction || oggetto || si || Oggetto che contiene i dati dei passaggi
 
−
|}
 
−
===== Oggetto PassageTransaction =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| CustomerIdentifier || numerico || si || Identificativo del cliente ottenuto registrando il cliente con il servizio RegisterCustomer (0 per biglietti non nominativi)
 
−
|-
 
−
| TicketIdentifier || numerico || si || Codice identificativo del biglietto
 
−
|-
 
−
| LogTime || data || si || Data e ora del passaggio
 
−
|-
 
−
| CheckpointName || testo || si || Identificativo testuale univoco (case sensitive) dell’impianto di risalita all’interno della società specificata
 
−
|-
 
−
|Values || oggetto || si || Oggetto che contiene i TokenValue
 
−
|}
 
−
===== Oggetto Values =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| TokenValue || oggetto || si || Oggetto che contiene i dati dei token
 
−
|}
 
−
===== Oggetto Token Value =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Name || testo || si || Nome del token
 
−
|-
 
−
| Value || testo || si || Valore del token
 
−
|}
 
−
==== Parametri output ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Descrizione
 
−
|-
 
−
| InsertedRecordsCount || numerico || Numero dei record effettivamente inseriti
 
−
|}
 
 
=== SETDAILYFIRSTPASSAGESCOUNT ===
 
=== SETDAILYFIRSTPASSAGESCOUNT ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_SetDailyFirstPassagesCount|Web Service: SetDailyFirstPassagesCount]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_SetDailyFirstPassagesCount|Web Service: SetDailyFirstPassagesCount]]
−
 
−
==== Parametri input ====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Group || numerico || si || Codice numerico univoco di identificazione del gruppo
 
−
|-
 
−
| Company || numerico || si || Codice numerico univoco di identificazione della stazione
 
−
|-
 
−
| Values || oggetto || si || Oggetto che contiene i DailyFirstPassagesCount
 
−
|}
 
−
===== Oggetto Values =====
 
−
{| class="wikitable"
 
−
! Parametro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| DailyFirstPassagesCount || oggetto || si || Oggetto che contiene i conteggi dei passaggi
 
−
|}
 
−
===== Oggetto DailyFirstPassagesCount =====
 
−
{| class="wikitable"
 
−
! Paramentro !! Tipo !! Obbligatorio !! Descrizione
 
−
|-
 
−
| Day || data || si || Data del giorno a cui si riferisce il conteggio dei passaggi
 
−
|-
 
−
| Count || numerico || si || Numero dei passaggi
 
−
|}
 
−
==== Parametri output ====
 
−
Nessun parametro.
 
  
 
=== ERRORI ===
 
=== ERRORI ===
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_Errori|Web Service: Errori]]
 
Per una spiegazione più dettagliata vedi la pagina: [[Web_Service_-_Errori|Web Service: Errori]]
−
{| class="wikitable"
 
−
! Sigla !! Significato
 
−
|-
 
−
| 200 Bad credentials || Le credenziali fornite sono errate
 
−
|-
 
−
| 201 Must login first || Non è stato eseguito il login
 
−
|-
 
−
| 202 Bad request  || Errore generico nella richiesta
 
−
|-
 
−
| 203 Unknown token || Un token menzionato nel formato non è conosciuto
 
−
|-
 
−
| 204 Unknown format || Il formato richiesto è sconosciuto
 
−
|-
 
−
| 205 Unknown ticket || Il biglietto richiesto è sconosciuto
 
−
|-
 
−
| 206 Unknown company || La società non è nell’elenco del server
 
−
|-
 
−
| 210 Unknown group || Il gruppo specificato non è noto al server
 
−
|-
 
−
| 211 Unknown Company || La società specificata non è nota al server
 
−
|-
 
−
| 212 Unknown workstation || La postazione specificata non è nota al server
 
−
|-
 
−
| 220 Unknown key || La chiave richiesta non è stata registrata
 
−
|-
 
−
| 301 Root.TicketID can not be empty or text || Si è inviata la registrazione di un biglietto sprovvisto di numero di identificazione o con numero di identificazione non numerico
 
−
|-
 
−
| 302 CustomerAge can not be empty || Si è inviata la registrazione di un biglietto sprovvisto di informazione relativa alla fascia di età, oppure con un codice relativo alla fascia di età errato
 
−
|}
 
  
 
== Servizi del Formato 3 -  Estensione dei servizi per la vendita online ==
 
== Servizi del Formato 3 -  Estensione dei servizi per la vendita online ==

Versione delle 13:13, 27 set 2016

Indice

Servizi del Formato 3

LOGIN

Per una spiegazione più dettagliata vedi la pagina: Web Service: Login

REGISTERTOKEN

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterToken

REGISTERFORMAT

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterFormat

ENUMERATEFORMATS

Per una spiegazione più dettagliata vedi la pagina: Web Service: EnumerateFormats

GETFORMAT

Per una spiegazione più dettagliata vedi la pagina: Web Service: GetFormat

REGISTERTICKET

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterTicket

ENUMERATETICKETS

Per una spiegazione più dettagliata vedi la pagina: Web Service: EnumerateTickets

GETTICKET

Per una spiegazione più dettagliata vedi la pagina: Web Service: GetTicket

ENUMERATEGROUPS

Per una spiegazione più dettagliata vedi la pagina: Web Service: EnumerateGroups

ENUMERATECOMPANIES

Per una spiegazione più dettagliata vedi la pagina: Web Service: EnumerateCompanies

ENUMERATEWORKSTATIONS

Per una spiegazione più dettagliata vedi la pagina: Web Service: EnumerateWorkstations

REGISTERWORKSTATIONKEY

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterWorkstationKey

ENUMERATEKEYS

Per una spiegazione più dettagliata vedi la pagina: Web Service: EnumerateKeys

GETKEY

Per una spiegazione più dettagliata vedi la pagina: Web Service: GetKey

REGISTERCUSTOMER

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterCustomer

REGISTERSALES

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterSales

REGISTERPASSAGES

Per una spiegazione più dettagliata vedi la pagina: Web Service: RegisterPassages

SETDAILYFIRSTPASSAGESCOUNT

Per una spiegazione più dettagliata vedi la pagina: Web Service: SetDailyFirstPassagesCount

ERRORI

Per una spiegazione più dettagliata vedi la pagina: Web Service: Errori

Servizi del Formato 3 - Estensione dei servizi per la vendita online

Authenticate

Informazioni generali

Titolo Authenticate
Descrizione Il servizio permette l'autenticazione per l'esecuzione dei servizi.
Il servizio restituisce un valore di sessione OPSESSIONID che dovrà essere passato come cookie di sessione in ogni servizio.
Tipo WS Rest
URL risorsa master2.openpass.it/Authenticate
Metodi consentiti POST

Parametri input

Nome Tipo Obbligatorio Descrizione
Login Text Si Login
Password Text Si Password

Parametri output

Nome Tipo Descrizione
OPSESSIONID Text Valore del cookie OPSESSIONID

Esempio di chiamata

Clicca su Espandi per visualizzare il codice 


$.ajax({
	url: "master2.openpass.it/Authenticate",
	dataType: "json",
	data: {
		Login: “valorelogin”,
		Password: “valorepassword”
	},
	type: "POST",
	success: function (r) {
		console.log(r);
	},
	error: function (r) {
		console.log(r.responseText);
	}
});

Esempio di risposta con successo

Codice Contenuto
200 
{
    "OPSESSIONID": 248028349082308
}

RegisterWebSales

Informazioni generali

Parametri input

Parametri output

GenerateTicket

Informazioni generali

Parametri input

Parametri output

GetCustomerStatus

Informazioni generali

Parametri input

Parametri output

GetCustomersDomain

Informazioni generali

Parametri input

Parametri output

GetCustomer

Informazioni generali

Parametri input

Parametri output

GetWebSales

Informazioni generali

Parametri input

Parametri output

GetStatusSales

Informazioni generali

Parametri input

Parametri output

SetDailyClosing

Informazioni generali

Parametri input

Parametri output

UpdateWebSalesAmmount

Informazioni generali

Parametri input

Parametri output

CreateDomain

Informazioni generali

Parametri input

Parametri output

RegisterDomain

Informazioni generali

Parametri input

Parametri output

GetDomainList

Informazioni generali

Parametri input

Parametri output

GetPassages

Informazioni generali

Parametri input

Parametri output

Errori

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