Formato delle risposte

Ogni chiamata restituisce un codice (“status code”) che identifica il successo o il fallimento dell’operazione, e una struttura dati contenente eventuali informazioni aggiuntive.
Lo status code può assumere i valori:
  • 2xx (tipicamente 200) indica il successo dell’operazione
  • 4xx indica il fallimento dell’operazione causato da una chiamata non corretta (esempio 403 Unauthorized, causato da un errore in userid/password)
  • 5xx indica il fallimento dell’operazione causato da problemi nel sistema di back-end (es 503 backend server error)
Informazioni comuni a tutte le risposte sono:
  • status: codice di ritorno, esempio “DOCUMENT_TYPE_NOT_FOUND”      
  • comment: descrizione leggibile dell’esito. Questo campo non dovrebbe essere utilizzato per effettuare un “parsing”, poiché può cambiare senza preavviso. Tutte le informazioni in questo campo possono essere trovati in altri campi

Tutte le richieste hanno un formato standard che può essere codificato in diverse modalità a scelta del programmatore.

Codifica JSON

{
    "status" : <STATUS>,
    "comment" : <HUMAN READABLE COMMENT>,
    ...
}

Attenzione: le informazioni riportate in questa sezione possono non essere perfettamente allineate con la versione corrente del servizio, in continua evoluzione. Per qualunque informazione specifica, vi preghiamo di contattarci.