Upload
hadiep
View
218
Download
0
Embed Size (px)
Citation preview
2 | Manuale di riferimento dei servizi Web
INDICE Cronologia delle revisioni ...................................................................................................................................... 3
1 Introduzione .................................................................................................................................................... 4
1.1 Panoramica ............................................................................................................................................ 4
1.2 Documentazione di supporto ................................................................................................................. 4
2 Operazioni preliminari .................................................................................................................................... 4
3 Panoramica del servizio GetOrderDetails ...................................................................................................... 5
3.1 GetOrderList .......................................................................................................................................... 6
3.2 GetOrderDetails ..................................................................................................................................... 6
3.3 Vantaggi del servizio GetOrderDetails .................................................................................................. 6
4 Informazioni di riferimento del servizio GetOrderDetails ................................................................................ 7
4.1 Schema di richiesta ............................................................................................................................... 7
4.2 Schema di risposta ................................................................................................................................ 7
4.2.1 GetOrderList ...................................................................................................................................... 7
4.2.2 GetOrderDetails ................................................................................................................................. 8
4.3 Schema di errore ................................................................................................................................. 12
4.4 Messaggi di richiesta ........................................................................................................................... 13
4.4.1 Messaggio di richiesta - GetOrderDetails ........................................................................................ 13
4.5 Messaggio di risposta .......................................................................................................................... 13
4.5.1 Messaggio di risposta - GetOrderList .............................................................................................. 13
4.5.2 Messaggio di risposta - GetOrderDetails ........................................................................................ 17
4.6 Messaggi di errore ............................................................................................................................... 21
4.6.1 Esempio di risposta di errore ........................................................................................................... 22
3 | Manuale di riferimento dei servizi Web
Cronologia delle revisioni Versione Data Autore Commenti
3.2 22/10/2015 AR Aggiunta della sezione Cronologia delle revisioni
3.3 04/12/2015 AR Sezione 4.5.2 aggiornata per riflettere le modifiche allo schema di risposta
3.4 21/12/2015 AR Aggiunta del campo serial_number nella
sezione 3.2
Messaggio di risposta modificato nella
sezione 4.5.1
Messaggio di risposta modificato nella
sezione 4.5.2
3.5 23/02/2016 RL Aggiunta dei campi item_po_number,
billing_start_date, billing_end_date,
billing_status,
item_cancellation_transaction_date e
cancellation_reason in order_items_array.
3.6 23/02/2016 RL Aggiunta del campo recurring_po in
order_header_array.
3.7 23/02/2016 ER Aggiunta del campo sales_licence_type nella
descrizione di order_items
3.8 31/03/2016 PL Aggiunta dei campi Street_2 e Street_3 nella
sezione 4.2.2
3.9 02/05/2016 PL Aggiunta dei campi activity, type,
transactiondate, previousqty e newqty nella
sezione 4.2.2 e aggiornamento della risposta
di esempio nella sezione 4.5.2
3.10 6 giugno 2016 FX Aggiunta del campo type e della
lunghezza/formato di output nelle sezioni
4.2.1 e 4.2.2
4 | Manuale di riferimento dei servizi Web
1 Introduzione
1.1 Panoramica
La piattaforma Digital Distribution Web Service (DDWS) è una soluzione che consente ai partner di effettuare automaticamente gli ordini dei prodotti Autodesk e che prevede un'interazione minima ("low touch") da parte dei partner e nessun intervento ("zero touch") da parte di Autodesk. Questa nuova funzionalità aziendale aprirà la strada a vere e proprie transazioni basate sui servizi Web B2B tra i partner e Autodesk.
Perché i partner possano implementare in modo efficace la piattaforma di servizi digitali di Autodesk, le società affiliate dovranno acquisire familiarità con i servizi Web REST, oAuth e JSON. In una guida alla programmazione è disponibile un'applicazione client di esempio scritta nel linguaggio Ruby, per consentire agli sviluppatori delle società affiliate di usufruire dell'API dei servizi digitali.
1.2 Documentazione di supporto
Autodesk Partner Developer Guide: questa guida fornisce ai partner informazioni utili per il processo di formazione e l'accesso ai servizi DDWS. Ha inoltre lo scopo di presentare ai partner la piattaforma di servizi digitali di Autodesk mediante istruzioni passo-passo che li guidino durante l'esecuzione delle attività iniziali necessarie per l'integrazione.
Authentication API Documentation: questo documento illustra ai partner il processo di generazione delle credenziali, delle firme e dei token di accesso necessari per utilizzare le API dei servizi. Contiene inoltre informazioni per lo sviluppo di un'applicazione di integrazione di un partner, fornisce informazioni di base sull'integrazione dei servizi Web e illustra lo sviluppo di un'applicazione tipica.
2 Operazioni preliminari
Durante il processo di formazione, i partner vengono associati a un Customer Specific Number (CSN) univoco e le loro applicazioni vengono registrate presso Autodesk. Per ulteriori informazioni sul processo di formazione, fare riferimento all'Autodesk Partner Developer Guide.
5 | Manuale di riferimento dei servizi Web
3 Panoramica del servizio GetOrderDetails
Il servizio GetOrderDetails fornisce ai partner informazioni dettagliate sugli ordini, inclusi numeri di contratto, numeri di serie e informazioni sui prodotti, oltre ad altri campi. Questi dati sono presentati in un
formato non elaborato e possono essere utilizzati nel sistema scelto da un partner. In questo documento sono descritti tutti gli scenari del servizio GetOrderDetails idonei per il recupero delle informazioni di un ordine all'interno dell'ambiente Autodesk.
Il servizio include due operazioni per il recupero degli ordini, attivate in base all'input immesso nel servizio GetOrderDetails:
GetOrderList
GetOrderDetails
6 | Manuale di riferimento dei servizi Web
3.1 GetOrderList
Lo scopo di questa operazione è ottenere l'elenco degli ordini da un sistema backend qualora l'input includa solo un intervallo di date. La risposta includerà dati che consentiranno a un partner di rieseguire il servizio allo scopo di ottenere i dettagli dell'ordine. Quando il richiedente riceve la risposta e recupera le informazioni necessarie, chiama il servizio GetOrderDetails utilizzando numero cliente/numero ordine di acquisto/numero ordine di vendita come input. Per richiamare l'operazione, è necessario specificare i seguenti input:
1. customer_number
2. order_date_from
3. order_date_to
3.2 GetOrderDetails
Lo scopo di questa operazione è ottenere i dettagli dell'ordine per un determinato input. Questa operazione può essere chiamata utilizzando i seguenti gruppi di input:
1. customer_number
2. Solo uno dei seguenti elementi:
a. serial_number
b. contract_number
c. partner_po
d. customer_po
e. order_number
Nota: la risposta dell'API GetOrderDetails conterrà solo un ordine valido.
3.3 Vantaggi del servizio GetOrderDetails
1. Un servizio Web REST leggero, facilmente eseguibile da qualsiasi applicazione tramite una
connessione HTTP(s).
2. Informazioni in tempo reale sullo stato dell'ordine e relativo riferimento.
3. Accesso immediato alle informazioni sull'ordine disponibili.
7 | Manuale di riferimento dei servizi Web
4 Informazioni di riferimento del servizio GetOrderDetails
4.1 Schema di richiesta
La tabella seguente include i dettagli dei parametri del messaggio di richiesta per GetOrderDetails.
Elemento Tipo di campo
Lunghezza/formato input
Utilizzo
Ele
me
nti
Ge
tOrd
erL
ist(
)
customer_number Stringa Lunghezza: max 10
caratteri Obbligatorio
order_date_from Data Formato: ISO 8601
AAAA-MM-GG Obbligatorio
order_date_to Data
Formato: ISO 8601 AAAA-MM-GG
(intervallo di date non superiore ai 90 giorni)
Obbligatorio
Ele
me
nti
Ge
tOrd
erD
eta
ils()
customer_number Stringa Lunghezza: max 10
caratteri Obbligatorio
contract_number Stringa Lunghezza: max 12
caratteri
È possibile trasmettere un
solo elemento con customer_number
partner_po Stringa Lunghezza: max 35
caratteri
customer_po Stringa Lunghezza: max 35
caratteri
order_number Stringa Lunghezza: 10 caratteri
serial_number Stringa Lunghezza: max 12
caratteri
4.2 Schema di risposta
4.2.1 GetOrderList
Per l'invio dell'intervallo di date, verranno visualizzate le colonne indicate di seguito.
Campo Tipo di campo
Lunghezza/formato di output
Descrizione
sales_order_number Stringa Lunghezza: max 10 caratteri
Numero ordine SAP
Generato dai sistemi Autodesk.
purchase_order_number Stringa Lunghezza: max 35 caratteri
Numero ordine di acquisto
Generato dal partner e inviato nella richiesta PlaceOrder.
8 | Manuale di riferimento dei servizi Web
order_date Data Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data di elaborazione ordine
customer_po_number Stringa Lunghezza: max 35 caratteri
Numero ordine di acquisto del cliente
Appartiene al rivenditore che effettua l'ordine tramite un altro rivenditore/distributore.
document_type Stringa Lunghezza: max 10 caratteri
Tipo di documento
customer_number Stringa Lunghezza: max 10 caratteri
Numero cliente
customer_name Stringa Lunghezza: max 35 caratteri
Nome del cliente
status Stringa Risposta di conferma: "Completed", "Open"
Stato dell'ordine
tracking_number Stringa Lunghezza: max 35 caratteri
Numero di riferimento
4.2.2 GetOrderDetails
Campo Tipo di campo
Lunghezza/formato di output
Descrizione
status Stringa Risposta di conferma: "OK", "FAILED", "ERROR"
Stato della richiesta
order_header_array [serie di oggetti JSON]
Campo Descrizione
order_date Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data di elaborazione ordine
sales_order_number Stringa Lunghezza: max 10 caratteri
Numero ordine SAP
Generato dai sistemi Autodesk.
purchase_order_number Stringa Lunghezza: max 35 caratteri
Numero ordine di acquisto
Generato dal partner e inviato nella richiesta PlaceOrder.
customer_po_number Stringa Lunghezza: max 35 caratteri
Numero ordine di acquisto del cliente
Appartiene al rivenditore che effettua l'ordine tramite un altro rivenditore/distributore.
document_type Stringa Lunghezza: max 10 caratteri
Tipo di documento
9 | Manuale di riferimento dei servizi Web
customer_number Stringa Lunghezza: max 10 caratteri
Numero cliente
customer_name Stringa Lunghezza: max 35 caratteri
Nome del cliente
order_status Stringa Lunghezza: max 20 caratteri
Stato dell'ordine
tracking_number Stringa Lunghezza: max 35 caratteri
Numero di riferimento
order_amount Stringa Lunghezza: max 15 caratteri
Importo dell'ordine
È il prezzo totale dell'ordine, che equivale al prezzo dei prodotti dell'ordine iniziale più il prezzo dei prodotti per la scadenza successiva, che verranno fatturati nel periodo di fatturazione successivo.
tax_amount Stringa Lunghezza: max 13 caratteri
Importo imposte
contract_number Stringa Lunghezza: max 12 caratteri
Numero contratto
È un numero univoco associato all'ordine principale.
shipment_method Stringa Lunghezza: max 20 caratteri
Metodo di spedizione
freight_charge Stringa Lunghezza: max 15 caratteri
Spese di trasporto
purchase_order_date Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data ordine di acquisto
contract_start_date Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data di inizio del contratto
È la data in cui inizierà la fatturazione. Corrisponde alla data dell'ordine, a meno che l'ordine non venga effettuato con una data di inizio futura.
contract_end_date Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data di fine del contratto
È la data di scadenza dell'abbonamento. Per gli ordini ricorrenti, questo campo sarà uguale a XXXXX.
contract_usage_type Stringa Lunghezza: max 3 caratteri
Tipo di uso del contratto
recurring_po Stringa Lunghezza: max 40 caratteri
Numero PO ricorrente
order_items_array [serie di oggetti JSON]
sales_order_number Stringa Lunghezza: max 10 caratteri
Numero ordine di vendita
line_number Stringa Lunghezza: max 6 caratteri
Numero riga
10 | Manuale di riferimento dei servizi Web
Item_po_number Stringa Lunghezza: max 40 caratteri
Numero ordine di acquisto voce
È il numero di ordine generato dal partner e inviato con la richiesta PlaceOrder. Se la voce viene generata durante l'ordine iniziale, il valore sarà uguale a quello dell'elemento purchase_order_number a livello di intestazione. In caso contrario, se un prodotto viene aggiunto allo stesso contratto in un secondo momento, conterrà il numero dell'ordine di acquisto della richiesta.
sku Stringa Lunghezza: max 18 caratteri
Numero materiale
È il numero che consente di identificare il prodotto ordinato. Il formato di questo campo è identico a quello riportato sotto "001H1-007778-T275"
sku_description Stringa Lunghezza: max 60 caratteri
Descrizione materiale
È la descrizione del prodotto ordinato.
quantity Numero intero
Lunghezza: max 15 caratteri
Quantità
unit_price Stringa Lunghezza: max 11 caratteri
Prezzo unitario
Rappresenta il prezzo di una postazione.
order_currency Stringa Lunghezza: max 5 caratteri
Valuta
È la valuta del valore monetario dell'ordine e viene definita in base alle impostazioni internazionali del partner che effettua l'ordine.
net_value Stringa Lunghezza: max 15 caratteri
Valore netto
product_key Stringa Lunghezza: max 30 caratteri
Codice prodotto
group_name Stringa Lunghezza: max 35 caratteri
Nome gruppo
serial_number Stringa Lunghezza: max 1300 caratteri
Vuoto se l'ordine è un rinnovo o si aggiungono postazioni
Generato da Autodesk per identificare in modo univoco il prodotto.
current_serial_number Stringa Lunghezza: max 130 caratteri
Vuoto se si tratta di un ordine iniziale o si aggiungono prodotti
seats Stringa Lunghezza: max 10 caratteri
Numero di postazioni
Per gli ordini di abbonamenti, questo campo è sempre uguale a 1. Per le licenze permanenti, rappresenta il numero di postazioni con licenza.
deployment Stringa Lunghezza: max 1 carattere
Installazione client
license_type Stringa Lunghezza: max 30 caratteri
Tipo di licenza
11 | Manuale di riferimento dei servizi Web
usage_type Stringa Lunghezza: max 3 caratteri
Tipo di utilizzo
license_description Stringa Lunghezza: max 155 caratteri
Descrizione della licenza
subs_id Stringa Lunghezza: max 48 caratteri
ID abbonamento, solo ricorrente
billing_start_date Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00
Data di inizio fatturazione
billing_end_date Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data di fine fatturazione
billing_status Stringa Stato fatturazione
item_cancellation_transaction_date
Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00 (ad es. 2016-06-06T17:51:00+0000)
Data della transazione di annullamento elemento
cancellation_reason Stringa Lunghezza: max 40 caratteri
Motivo annullamento
sales_licence_type Stringa Lunghezza: max 30 caratteri
"New" o "Renewal"
order_partners_array [serie di oggetti JSON]
sales_order_number Stringa Lunghezza: max 10 caratteri
Numero ordine di vendita
line_number Stringa Lunghezza: max 6 caratteri
Numero riga
partner_type Stringa Lunghezza: max 15 caratteri
Per ogni tipo di partner, verranno visualizzate tutte le informazioni corrispondenti. Tipi di partner: persona di contatto, rivenditore, utente finale, destinatario fatturazione, destinatario spedizione e Contract Manager.
partner_number Stringa Lunghezza: max 10 caratteri
Numero partner
contact_number Stringa Lunghezza: max 10 caratteri
Numero di contatto
partner_name Stringa Lunghezza: max 80 caratteri
Nome partner
street Stringa Lunghezza: max 30 caratteri
Via
street_2 Stringa Lunghezza: max 40 caratteri
Riga indirizzo 2
street_3 Stringa Lunghezza: max 40 caratteri
Riga indirizzo 3:
po_box Stringa Lunghezza: max 10 caratteri
Casella postale
city Stringa Lunghezza: max 25 caratteri
Città
12 | Manuale di riferimento dei servizi Web
postal_code Stringa Lunghezza: max 10 caratteri
Codice postale
pobox_postal_code Stringa Lunghezza: max 10 caratteri
Codice postale corrispondente alla casella postale
country Stringa Lunghezza: max 15 caratteri
Paese
district Stringa Lunghezza: max 25 caratteri
Quartiere
region Stringa Lunghezza: max 3 caratteri
Regione
end_user_email Stringa Lunghezza: max 241 caratteri
assetdetailslist [serie di oggetti JSON]
serialnumber Stringa Lunghezza: max 18 caratteri
Tutti i numeri di serie associati all'ordine
registereddate Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00
Data di registrazione per ogni numero di serie
activity [serie di oggetti JSON]
Elemento di assetdetailslist, elenco di tracce di controllo
type Stringa Lunghezza: max 15 caratteri
Remove seat. In questa sezione vengono inseriti dati relativi agli scenari di rimozione delle postazioni.
transactiondate Stringa Formato: ISO 8601 AAAA-MM-GG Thh:mm:ss+00:00
Data e ora di rimozione della postazione
previousqty Numero intero
Lunghezza: max 15 caratteri
Numero di postazioni precedenti
newqty Numero intero
Lunghezza: max 15 caratteri
Numero di nuove postazioni
welcomekitstatus Stringa Lunghezza: max 100 caratteri
"Sent", "Not Sent"
Nota: poiché ora esiste il servizio GetOrderDetails, il campo relativo allo stato del kit di benvenuto (welcomekitstatus) restituisce la risposta di default "Not Sent". Questo flag verrà aggiornato in futuro quando il servizio GetOrderDetails sarà stato completamente sviluppato.
4.3 Schema di errore
Nome campo Descrizione
status Risposta di conferma: "OK", "FAILED", "ERROR"
message Messaggio di errore
transactionid ID di transazione univoco (combinazione di numero di ordine e data/ora). Viene restituito solo in caso di esito positivo dell'operazione.
13 | Manuale di riferimento dei servizi Web
4.4 Messaggi di richiesta
Di seguito sono riportati alcuni esempi di richieste di GetOrderDetails
4.4.1 Messaggio di richiesta - GetOrderDetails
4.5 Messaggio di risposta
Nota: Autodesk invia una risposta con la struttura seguente. In base alle proprie esigenze, i partner possono utilizzare strutture di risposta con formati diversi.
4.5.1 Messaggio di risposta - GetOrderList
{ "status": "OK", "message": { "elements": [ { "order_list_array": [ {
[Getting GetOrderList using Customer Number and Date Range]
https://enterprise-api-
stg.autodesk.com/v1/orders?customer_number=51174443900&order_date_from=2015-05-
01&order_date_to=2015-07-29
Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>>
[Getting GetOrderDetails using Customer Number and Serial Number]
https://enterprise-api-
stg.autodesk.com/v1/orders?customer_number=5117444390&serial_number=D45-
10000111
Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>>
14 | Manuale di riferimento dei servizi Web
"sales_order_number": "7044892531", "purchase_order_number": "PONFRtes", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123355730", "customer_name": "newstgsasp endcomp", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044788406", "purchase_order_number": "RCG-annual-renew No order date", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "Cust po renew no orderdate", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7044788407", "purchase_order_number": "InitialOrderQTR1130", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472202", "customer_name": "Initialorderqtr 1130", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044788408", "purchase_order_number": "InitialOrderQTR1130A", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472202", "customer_name": "Initialorderqtr 1130", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044788410", "purchase_order_number": "AddSeat1130PT", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "01234567890123456789012345678901234", "document_type": "GG Standard Order", "customer_number": "1430176516", "customer_name": "SAMPLE NAME", "status": "Completed", "tracking_number": ""
15 | Manuale di riferimento dei servizi Web
}, { "sales_order_number": "7044790246", "purchase_order_number": "testpo983534362", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7044790248", "purchase_order_number": "testpo98353436432", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790250", "purchase_order_number": "testpo8362932", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790252", "purchase_order_number": "testpo8912371239283", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790560", "purchase_order_number": "RCG Initial Dec 01", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "12345678899", "document_type": "GG Standard Order", "customer_number": "5123459790", "customer_name": "Sample Name",
16 | Manuale di riferimento dei servizi Web
"status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7044790562", "purchase_order_number": "NewOrder1201PT", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472262", "customer_name": "Neworder 1201Pt", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7044790565", "purchase_order_number": "RenewalOrder1201PT", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "GG Standard Order", "customer_number": "5123472265", "customer_name": "Renewalorder 1201Pt", "status": "Completed", "tracking_number": "" }, { "sales_order_number": "7344575547", "purchase_order_number": "ddwsmultiseattest2", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "Online Transaction", "customer_number": "5123460006", "customer_name": "SEnterprises", "status": "Being processed", "tracking_number": "" }, { "sales_order_number": "7344575551", "purchase_order_number": "functest_1449009521", "order_date": "2015-12-01T00:00:00+0000", "customer_po_number": "", "document_type": "Online Transaction", "customer_number": "5123460006", "customer_name": "SEnterprises", "status": "Being processed", "tracking_number": "" } ] } ] } }
17 | Manuale di riferimento dei servizi Web
4.5.2 Messaggio di risposta - GetOrderDetails
{ "status": "OK", "message": { "elements": [ { "order_header_array": [ { "order_date": "2015-12-01T00:00:00+0000", "sales_order_number": "7055788410", "purchase_order_number": "AddSeat1130PT", "customer_po_number": "01234567890123456789012345678901234", "document_type": "GG Standard Order", "customer_number": "1430176516", "customer_name": "Sample & Co", "order_status": "Completed", "tracking_number": "", "order_amount": "601.33", "tax_amount": "0.00", "contract_number": "110001161985", "shipment_method": "IBLFMJDPIEDCAJFHIDGN", "freight_charge": "0.00", "purchase_order_date": "2015-12-01T00:00:00+0000", "contract_start_date": "2015-10-16T00:00:00+0000", "contract_end_date": "2016-01-15T00:00:00+0000", "contract_usage_type": "COM", “recurring_po”: “AddSeat1130PT-recurring-po” } ], "order_items_array": [ { "sales_order_number": "7055788410", "line_number": "000010", "item_po_number": "712100004772", "sku": "765G1-008204-T820", "sku_description": "BDSP 2015 TBP:QT SUB +1", "quantity": 1, "unit_price": "601.33", "order_currency": "USD", "net_value": "601.33", "product_key": "765G1", "group_name": "", "serial_number": "", "current_serial_number": "560-38200294", "seats": "1", "deployment": "S", "license_type": "New", "usage_type": "COM", "license_description": "Autodesk Building Design Suite Premium 2015", "subs_id": "", "billing_start_date": “2015-10-16T00:00:00+0000”, "billing_end_date": “2016-01-15T00:00:00+0000”,
18 | Manuale di riferimento dei servizi Web
"billing_status": "N/A", "item_cancellation_transaction_date": null, "cancellation_reason": "", "sales_licence_type": "New" } ], "order_partners_array": [ { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Contact Person", "partner_number": "", "contact_number": "0019490593", "partner_name": "InitialOrderQTR1130", "street": "Sample Ave", “street_2”: “Engineering Dept”, “street_3”: “Office 5432”, "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "", "country": "US", "district": "MARIN", "region": "CA", "end_user_email": "[email protected]" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Dealer", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO BOX", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "End User", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO Box", "city": "Clearwater",
19 | Manuale di riferimento dei servizi Web
"postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Bill to", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO BOX", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Ship to", "partner_number": "1430176516", "contact_number": "0000000000", "partner_name": "Sample & Co", "street": "Buenavista St", "po_box": "PO BOX", "city": "Clearwater", "postal_code": "33760-3122", "pobox_postal_code": "33760-3122", "country": "US", "district": "PINELLAS", "region": "FL", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000000", "partner_type": "Contract Mgr", "partner_number": "5123472202", "contact_number": "0000000000", "partner_name": "Initialorderqtr 1130", "street": "Sample Ave", "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "",
20 | Manuale di riferimento dei servizi Web
"country": "US", "district": "MARIN", "region": "CA", "end_user_email": "" }, { "sales_order_number": "7055788410", "line_number": "000010", "partner_type": "Contact Person", "partner_number": "", "contact_number": "0019490593", "partner_name": "InitialOrderQTR1130", "street": "Sample Ave", "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "", "country": "US", "district": "MARIN", "region": "CA", "end_user_email": "[email protected]" }, { "sales_order_number": "7055788410", "line_number": "000010", "partner_type": "Contract Mgr", "partner_number": "5123472202", "contact_number": "0000000000", "partner_name": "Initialorderqtr 1130", "street": "Sample Ave", "po_box": "", "city": "San Jose", "postal_code": "98516", "pobox_postal_code": "", "country": "US", "district": "MARIN", "region": "CA", "end_user_email": "" } ], "assetdetailslist": [ { "serialnumber": "560-38200294", "registereddate": null "activity": [ { "type": "Remove Seat", "transactiondate": "2016-04-28T23:03:52.000Z", "previousqty": "3", "newqty": 2 }, { "type": "Remove Seat",
21 | Manuale di riferimento dei servizi Web
"transactiondate": "2016-04-29T22:17:51.000Z", "previousqty": "2", "newqty": 1 } ] } ], "welcomekitstatus": "Not Sent" } ] }
}
4.6 Messaggi di errore
La tabella seguente include i codici di errore con i rispettivi messaggi di errore presenti nei messaggi di risposta quando viene rilevato un errore:
Numero messaggio
Messaggio di errore
003 & non trovato.
013 Il parametro di input non è completo.
015 Numero di ordine non trovato.
016 Numero di ordine non trovato.
017 Il numero di serie specificato non è valido.
018 La durata deve essere inferiore ai novanta (90) giorni.
UAN-GEN-00119 Il formato del numero di serie specificato non è corretto.
UAN-GEN-00108 Specificare il numero cliente.
UAN-GEN-00108 Immettere la data di inizio nel formato AAAA-MM-GG.
UAN-GEN-00119 Immettere la data di inizio nel formato AAAA-MM-GG.
UAN-GEN-00108 Immettere la data di fine nel formato AAAA-MM-GG.
UAN-GEN-00119 Immettere la data di fine nel formato AAAA-MM-GG.
UAN-INV-00002 La data di inizio deve essere precedente alla data di fine.
UAN-GEN-00141 L'intervallo di date non deve essere superiore ai 90 giorni. Controllare i dati immessi e provare di nuovo.
UAN-GEN-00119 Numero cliente non valido. Controllare i dati immessi e provare di nuovo.
UAN-GEN-00123 Il numero cliente non può superare i 10 caratteri. Controllare i dati immessi e provare di nuovo.
UAN-GEN-00119 Specificare una combinazione di parametri valida.
UAN-GEN-00119 Specificare i nomi dei parametri corretti.
UAN-GEN-00108 Specificare un numero di ordine o un altro numero di documento valido.
UAN-GEN-00123 Il numero di ordine deve contenere esattamente 10 caratteri. Controllare i dati immessi e provare di nuovo.
UAN-GEN-00123 Il numero dell'ordine di acquisto non può superare i 35 caratteri. Controllare i dati immessi e provare di nuovo.
Specificare almeno uno dei seguenti parametri: SerialNumber, ContractNumber, OrderNumber o PONumber.
Il numero di serie specificato non è valido.
APG-DWS-INV-002 Il numero cliente specificato non è valido.
UAN-GEN-00123 Il PO del partner non può superare i 35 caratteri. Controllare i dati immessi e provare di nuovo.
22 | Manuale di riferimento dei servizi Web
UAN-GEN-00123 Il numero di contratto non può superare i 12 caratteri. Controllare i dati immessi e provare di nuovo.
4.6.1 Esempio di risposta di errore
Nota: questo manuale di riferimento del servizio è destinato all'utilizzo esclusivo dei legittimi destinatari e può contenere informazioni proprietarie e/o riservate di natura privilegiata o comunque protette dalla divulgazione. La revisione, l'uso, la divulgazione o la distribuzione non autorizzati sono vietati.
{ "status": "Error", "transactionid": "INV51046287871433503736", "message": [ { "error_code": " APG-DWS-INV-002", "error_message": "Provided customer number is invalid." } ] }