Elencare le notifiche ricevute
La chiamata che dovrai fare per elencare le notifiche ricevute:
- GET https://endpoint/api/v1/notifications
Questa richiesta permette di caricare la lista delle notifiche ricevute in un certo intervallo di tempo.
Parametri della richiesta:
- apiKey: API KEY associate alla partita iva del mittente della fattura che si vuole inviare;
- page: (default = 1) pagina da caricare;
- withinAfter: il formato deve essere YYYY-MM-DD HH:MM:SS. Nella lista saranno presenti
- withinBefore: (opzionale) il formato deve essere YYYY-MM-DD HH:MM:SS. Nella lista saranno presenti solo le notifiche ricevute ad un orario successivo o uguale a withinAfter e precedente o uguale a withinBefore.
Formato risposta valida:
{
"data": [
{
"notificationId": "456def",
"notificationKind": "RicevutaConsegna",
"invoiceId": "123abc",
"timestamp": "2018-01-01 13:10:00",
},
{
"notificationId": "456def",
"notificationKind": "RicevutaConsegna",
"invoiceId": "123abc",
"timestamp": "2018-11-26T10:52:17.000000Z",
}
// Altre notifiche fino ad un massimo di 1000
]
"meta": {
"current_page": 1,
"last_page": 3,
"per_page": 15,
"from": 1,
"to": 10,
"total": 35
}
}
Il campo notificationId identifica univocamente la notifica nel sistema ed è utilizzabile, successivamente, per richiedere dettagli sulla notifica.
Il campo timestamp identifica quando la notifica è stata aggiunta al sistema. Si noti che questo timestamp può differire dall’ora di invio o ricezione notifica disponibile nei dettagli della notifica.
Si noti che la risposta conterrà fino ad un massimo di 1000 elementi in ordine cronologico.
Possibili errori:
Codice | Messaggio |
000 | Errore generico. |
001 | Api key mancante. |
002 | Api key non valida. |
003 | Api key non ancora attiva |
004 | Api key scaduta. |
005 | Parametro richiesta mancante. |
006 | Parametro richiesta errato. |