Passer au contenu principal
Toute liste répond avec la même enveloppe et se parcourt par curseur :
  • limit : 1 à 100, 50 par défaut. cursor : la valeur de nextCursor de la page précédente, à renvoyer telle quelle.
  • nextCursor nul signifie la fin de la liste. Il n’y a ni page, ni offset, ni total.
  • Une page peut contenir moins d’éléments que limit, voire aucun, sans être la dernière : suivez nextCursor tant qu’il n’est pas nul. C’est le cas de GET /availability, qui borne le nombre de jours de location (véhicules × jours) chiffrés par page.
  • Les collections courtes (saisons, calendrier des saisons, paliers de délai, remises de durée, états des lieux, opérations et alertes d’entretien) ont la même enveloppe avec nextCursor toujours nul ; elles n’acceptent ni limit ni cursor.
  • L’ordre de chaque liste est indiqué sur l’opération et toujours total (le dernier critère est id) ; il n’y a pas de paramètre de tri.
  • Un curseur de liste n’expire pas, mais ne vaut que pour les filtres de la requête qui l’a produit (sinon 400 sur cursor).
Exception : GET /events. Ce flux n’a pas de fin : son nextCursor n’est jamais nul et expire après 30 jours. La boucle de lecture est décrite dans Synchronisation par événements.

​
Filtres

  • Un filtre porte le nom du champ filtré : status, vehicleId, customerId, categoryId, partnerReference, isActive, vehicleType…
  • Un filtre qui accepte plusieurs valeurs le précise sur l’opération ; les valeurs se séparent alors par des virgules (status=RESERVED,IN_PROGRESS). Les autres filtres prennent une seule valeur.
  • from et to (YYYY-MM-DD, inclus, fuseau de l’agence) bornent une fenêtre de jours.
  • Un booléen s’écrit true ou false ; filtre omis, tous les éléments.
  • Un paramètre inconnu répond 400.