Documentazione AR APIv2 1.0.8 Help

Get All By Company

badge Status-ACTIVE

La chiamata di elenco Cards per Company permette di:

  • Ricevere l’elenco di Cards attive, nel dettaglio, per la Company di appartenenza;

Richiede in ingresso:

  • Nessun parametro;

Restituisce:

  • L’elenco di Cards;

  • Oppure, se non va a buon fine, la descrizione dell’errore riscontrato;

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/Cards/GetAllByCompany

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/Cards/GetAllByCompany

Metodo

GET

Success Response

200 (Success)

Error Response

400 (Bad Request)
401 (Unauthorized)
500(Internal Server Error)

Di seguito la struttura dell’Header contenente:

Header

{ "authorization": "Bearer -indicare-qui-Token-fornito-" }

Il codice univoco della Card va inserito come parametro nell’URL andando a sostituire {cardCode} all’interno dell’indirizzo.

In questo caso il 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

{ "cards": [ { "name": "[string]{nome della Card}", "description": "[string]{descrizione della Card}", "priceBought": [float]{prezzo di vendita}, "codeProduct": "[string]{codice identificativo del prodotto}", "codeEAN": "[string]{codice EAN del prodotto}", "serviceName": "[string]{nome del Servizio fornito}", "serviceCodeProduct": "[string]{codice del Servizio fornito}" } ] }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/Cards/GetAllByCompany

Header

{ "authorization": "Bearer NTNv7j0TuYARvmNMmWXo6fKvM4o6nv/aUi9ryX38ZH+L1bkrnD1ObOQ8Jdav" }

Request body

{ }

In caso di Successo il sistema ritorna il seguente modello JSON:

Response body

{ "cards": [ { "name": "SERVIZIO SMART", "description": "SERVIZIO SMART", "priceBought": 39.9, "codeProduct": "SIRTIE12SMART", "codeEAN": "2111009901111", "serviceName": "SERVIZIO SMART", "serviceCodeProduct": "SIRTIE12SMART" } ] }

In caso di Errore il sistema ritorna il seguente modello JSON:

Response

Status: 500 Internal Server Error

{ "error": "Impossibile risalire al socio." }

Errori Riscontrabili

Di seguito la lista che indica gli errori che possono essere riscontrati:

Codice

Descrizione

400
(BadRequest)

I dati in ingresso non sono corretti o non sono correttamente formattati. Viene restituita la descrizione dell’errore nel dettaglio.

401
(Unauthorized)

Il codice Token fornito non è valido. L’autenticazione non è andata a buon fine.

500
(Internal Server Error)

Il server ha riscontrato un errore inaspettato, generalmente esula dal tipo di request e si verifica per problemi assoggettabili al sistema.

17 novembre 2025