Paginazione Risultati

Le API di Sibill supportano la paginazione dei risultati per gestire le risposte con un numero elevato di elementi attraverso l'utilizzo del cursore di paginazione. Il cursore rappresenta un puntatore alla posizione corrente nella lista dei risultati e viene utilizzato per recuperare i dati successivi.

Per impostazione predefinita, le risposte contengono 25 elementi per pagina, ma è possibile impostarne un numero diverso. Il numero massimo di elementi per pagina è 100, il numero minimo è 1. È necessario un cursore per scorrere tutti i risultati.

Come si fa

La prima chiamata API può essere effettuata senza parametri per ottenere i primi risultati, mentre le chiamate successive devono includere il cursore restituito nella risposta precedente. Questo è un esempio di come utilizzare il cursore per ottenere i risultati successivi nel caso dell'endpoint GET /api/v1/companies/:company_id/documents:

GET /api/v1/companies/:company_id/documents?page_size=25

HTTP/1.1 200 Ok
Content-Type: application/json

{
   "data":[
      {
         "created_at":"2025-03-06T08:21:37.999777Z",
         "delivery_date":null,
         "delivery_status":null,
         "format":"FPR12",
         "id":"aa5d3bb5-a8b8-4124-9ce1-47963b56c260",
         "number":"document-number-ddonp",
         "status":"CREATED",
         "updated_at":"2025-03-06T08:21:37.999777Z"
      },
      ...
   ],
   "page":{
      "cursor":"g3QAAAACdwJpZG0AAAAkYzg3ZTNiYmMtYzNhZi00ZmFjLThkNzYtNmE1MTgzMDRhYdw1pY3JvkYXJ3E0NQRjEyAA==",
      "size":25
   }
}

GET /api/v1/companies/:company_id/documents?page_size=25&cursor=g3QAAAACdwJpZG0AAAAkYzg3ZTNiYmMtYzNhZi00ZmFjLThkNzYtNmE1MTgzMDRhYdw1pY3JvkYXJ3E0NQRjEyAA==

HTTP/1.1 200 Ok
Content-Type: application/json

{
   "data":[
      {
         "created_at":"2025-03-06T08:21:37.970759Z",
         "delivery_date":null,
         "delivery_status":null,
         "format":"FPR12",
         "id":"c87e3bbc-c3af-4fac-8d76-6a518304ab22",
         "number":"document-number-kpygo",
         "status":"CREATED",
         "updated_at":"2025-03-06T08:21:37.970759Z"
      },
      ...
   ],
   "page":{
      "cursor":"PDF6Z0A81MszpgYZV5zqkNNUhAsHXSyXZ+CdVcW+3+uOg9wGKAmMSDgKKZQJWfgO3loB/hsyiTYczy0Rk1mbrQ==",
      "size":25
   }
}