Rinnovo
La chiamata di rinnovo CardReleased permette, indicando il codice univoco della Card rilasciata in precedenza, di:
Rilasciare la Card con le medesime specifiche di quella precedente;
Associare la Card allo stesso Utente a cui era associata la precedente;
Registrare la Vendita della Card;
(Opzionale) Rilasciare le Licenze Software eventualmente associate alla Card;
Al momento, il rinnovo prevede un rilascio della validità prestabilita di 12 mesi, per la Card.
Gestione scadenze:
Card scaduta: la nuova Card ha validità dal momento in cui viene richiesto il rinnovo;
Card attiva: la nuova Card ha validità dalla data di scadenza di quella precedente;
Richiede in ingresso:
Codice univoco e identificativo della Card;
Restituisce:
Codice della Card appena rilasciata (rinnovo);
Email dell’Utente a cui è associata la Card;
Data di scadenza della Card;
(Opzionale) Lista di licenze Software rilasciate, o info sullo stato del rilascio (in caso di software multipli o errore);
Oppure, se non va a buon fine, la descrizione dell’errore riscontrato;
Softwares: Nel caso in cui siano associati 1 o più Softwares alla Card rilasciata, verrà gestita con la seguente logica il rilascio delle licenze software designate:
Software singolo per gruppo software: rilascio immediato della licenza;
Software multiplo per gruppo software: notifica che ci indica di effettuare chiamata di selezione software per la Card (chiamata in fase di implementazione);
Chiave | Valore |
|---|---|
Indirizzo Test | https://test-apiv2.smiletech.it/APIv2/CardReleaseds/RenewCard/{cardCode} |
Indirizzo Prod | https://apiv2.smiletech.it/APIv2/CardReleaseds/RenewCard/{cardCode} |
Metodo | POST |
Success Response | 200 (Success) |
Error Response | 400 (Bad Request) |
Di seguito la struttura dell’Header contenente:
Header
Il codice univoco della Card va inserito come parametro nell’URL andando a sostituire {cardCode} all’interno dell’indirizzo.
In questo caso la struttura body di request non è necessaria e rimane vuota:
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/CardReleaseds/RenewCard/006D25ADB1454157
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. |