Pagination et champs
Les listes, les champs rendus, les valeurs absentes et la mise en cache côté client.
Les listes
Une opération qui rend une liste se lit page par page, par curseur : Recherche d'annonces analysées (limite, curseur, réponse curseur_suivant), Biens semblables à une annonce (limite, curseur, réponse curseur_suivant), Pige complète : annonces actives et retirées du lac (limite, curseur, réponse curseur_suivant), Annonces dans une emprise de carte (limite, curseur, réponse curseur_suivant), Copropriétés du Registre national (limite, curseur, réponse curseur_suivant), Ventes DVF autour d'un point, dans une commune ou par mutation (limite, curseur, réponse curseur_suivant), Un DPE par son numéro, ou les DPE d'un disque ou d'une commune (limite, curseur, réponse curseur_suivant), Adresses à prospecter d'un secteur (limite, curseur, réponse curseur_suivant), Radar de prospection d'une commune ou d'un département (limite, curseur, réponse curseur_suivant), Classement de communes (screener) (limite, curseur, réponse curseur_suivant), Palmarès de communes par indicateur (limite, curseur, réponse curseur_suivant), Avis des investisseurs sur une commune (limite, curseur, réponse curseur_suivant), Objets d'urbanisme dans une emprise (limite, curseur, réponse curseur_suivant), Recherche d'autorisations d'urbanisme (limite, curseur, réponse curseur_suivant), Agences et réseaux immobiliers (limite, curseur, réponse curseur_suivant), Agents et mandataires (limite, curseur, réponse curseur_suivant), Flux d'évènements des annonces (limite, curseur, réponse curseur_suivant), Flux de nouveautés à l'adresse (limite, curseur, réponse curseur_suivant), Résultats des veilles et des alertes (limite, curseur, réponse curseur_suivant), Conversations du Hub (limite, curseur, réponse curseur_suivant), Lecture structurée d'un jeu de données (limite, curseur, réponse curseur_suivant), Briefs rédigés (limite, curseur, réponse curseur_suivant), Notifications du compte (limite, curseur, réponse curseur_suivant). Renvoyez le curseur rendu pour la page suivante ; un curseur null marque la fin.
Le coût se compte par élément rendu : une page plus courte coûte moins.
Les champs rendus
Ces opérations laissent choisir les champs rendus par le paramètre champs : Annonce par lien ou identifiant, Recherche d'annonces analysées, Pige complète : annonces actives et retirées du lac, Faits complets d'une adresse, Un DPE par son numéro, ou les DPE d'un disque ou d'une commune, Lecture structurée d'un jeu de données. Les autres rendent tous leurs champs.
La mise en cache côté client
Une réponse GET porte un ETag. Renvoyez-le dans If-None-Match : si rien n'a changé, l'API répond 304, sans corps et sans débit.
curl -H "Authorization: Bearer $PILLR_CLE" \
-H 'If-None-Match: "..."' ...Guide suivant : Lots