WebService PowerBoutique: Pagination

De Centre Documentation PowerBoutique
Aller à : navigation, rechercher

Certaines URL du Web Service vous permettent d'obtenir un listing de différentes ressources de même type, exemple "/gesco/commande/" permet d'obtenir la liste complète des commandes passées sur la licence. Ces listes étant de taille variable un système de pagination est automatiquement mis en place, basé sur la méthode standard "Partial Content".

A la différence du standard HTTP toutefois le Web Service renverra une réponse "Partial Content" automatiquement si le nombre de ressource de la collection est supérieur a 10.

Un process standard pour récupérer une collection de ressource ressemblera donc à cela:


r := GET (xx/gesco/commande)
Si r.responseCode = 206
Alors
(type, debut, fin, nbre) := LectureRange(r.Content-Range)
Faire
r := GET (xx/gesco/commande, "Range: ${type}=${fin+1}-${fin+11}")
Si r.responseCode = 206
Alors
(type, debut, fin, nbre) := LectureRange(r.Content-Range)
FinSi
TantQue fin<nbre
FinSi


Dans cet exemple de requête sur la collection produit, l'API vous informe par le code 206 que seule une partie des éléments disponible est renvoyé dans la réponse qui suit les entêtes, que la collection contient 624 élement de type "item", et que les éléments renvoyés sont les 10 premiers (id 0 à id 9).