Pagination

Pagination

Ce document décrit l'utilisation de la pagination implémentée dans les API de Skalin.

Info

L'API de Skalin dispose de pagination pour la plupart des appels de listing comme les appels Customers, Contacts, Agreements et Tasks.

Mise en place de la pagination basée sur l'offset

Sur nos points de terminaison GET, nous offrons une pagination basée sur l'offset. Les paramètres qui contrôlent ce type de pagination sont page et size, indiquant la page désirée et le nombre d'éléments à retourner par page.

page	integer	Index de la page. Si non définie, la valeur par défault est 1.
size	integer	Nombre maximum d'éléments renvoyés par page. S'il n'est pas indiqué, 100 éléments seront renvoyés.

Réponse de l'API avec pagination

Dans l'objet metadata de la réponse, un objet de pagination sera retourné. L'objet metadata.pagination contiendra les valeurs page et size données, ainsi que le nombre total d'élément et le flag hasNextPage, indiquant si d'autres éléments peuvent être récupérés après cette requète.

La valeur maximale de la limite de taille est de 500.

Réponse API avec des métadonnées de pagination

{
  "status": "success",
	"metadata": {
		"pagination": {
			"size": 50,
			"page": 2,
			"total": 82,
            "hasNextPage": false
		}
	},
	"data": [
		{
      ...
    }
  ]
};