API Responses¶
Il servizio API di Sign utilizza globalmente un middleware per incapsulare ogni risposta di una determinata chiamata API Rest in un modello JSON standard.
Tale struttura consente di gestire al meglio errori eventualmente restituiti e con metadati aggiuntivi alla risposta come ad esempio un messaggio di errore testuale.
Quando una richiesta HTTP ha esito positivo con Status Code1 2xx(Success) tale modello incapsula la risorsa richiesta come valore della proprietà definita con chiave "Data", tale valore può essere rappresentato come object o come array:
Nel caso in cui una richiesta non ha esito positivo e restituirà un determinato Status Code (Riportato nella proprietà definita con chiave HttpStatusCode), avrà tale struttura:
-
Lo status code di una richiesta HTTP è un codice numerico che viene restituito dal server in risposta a una richiesta HTTP effettuata dal client. ↩