Details
La chiamata di Dettaglio Utente permette, indicando i parametri dello stesso, di:
Ricevere il dettaglio dell’ User indicato;
Richiede in ingresso:
Parametri dell’Utente
Restituisce:
Il dettaglio dell’Utente;
Oppure, se non va a buon fine, la descrizione dell’errore riscontrato;
Chiave | Valore |
|---|---|
Indirizzo Test | https://test-apiv2.smiletech.it/APIv2/Users/Details |
Indirizzo Prod | https://apiv2.smiletech.it/APIv2/Users/Details |
Metodo | PUT |
Success Response | 200 (Success) |
Error Response | 400 (Bad Request) |
Di seguito la struttura dell’Header contenente:
Header
Di seguito la struttura del body contenente i valori da inserire all’interno della richiesta:
Request body
Di seguito la struttura della response contenente i valori di ritorno dal sistema:
Response body
Un esempio di chiamata con dati verosimili:
https://test-apiv2.smiletech.it/APIv2/Users/Details
Header
Request body
In caso di Successo il sistema ritorna il seguente modello JSON:
Response body
In caso di Errore il sistema ritorna il seguente modello JSON:
Response
Status: 400 Bad Request
Errori Riscontrabili
Di seguito la lista che indica gli errori che possono essere riscontrati:
Codice | Descrizione |
|---|---|
400 | I dati in ingresso non sono corretti o non sono correttamente formattati. Viene restituita la descrizione dell’errore nel dettaglio. |
401 | Il codice Token fornito non è valido. L’autenticazione non è andata a buon fine. |
500 | Il server ha riscontrato un errore inaspettato, generalmente esula dal tipo di request e si verifica per problemi assoggettabili al sistema. |