Lecture

Lister les lieux d'un agenda

Lire les lieux liés à un agenda se fait avec une requête get sur la route suivante:

/v2/agendas/{agendaUid}/locations

Les résultats sont paginés.

Important: Une authentification est nécessaire pour cette opération.

Les paramètres suivant peuvent être précisés:

size: Facultatif. Un entier déterminant le nombre de lieux maximum contenus dans la réponse
detailed: Facultatif. Lorsque ce paramètre est présent, la réponse comprend les données de tous les champs de chaque lieu.
after: Facultatif. Voir la section suivante.
from: Facultatif. Pour récupérer le jeu de résultat à partir du n-ième lieu. Lorsque c'est possible, préférer la navigation en utilisant "after".
order: Facultatif. Valeurs possibles: name.asc, name.desc, createdAt.asc, createdAt.desc

updatedAt[gte]: filtrer sur les lieux mis à jour au delà d'une date donnée (ex: 2023-06-02T12:40:00+0100 ou 2023-06-02)
updatedAt[lte]: filtrer sur les lieux mis à jour avant une date donnée (ex: 2023-06-02T12:40:00+0100 ou 2023-06-02)
createdAt[gte]: filtrer sur les lieux créés au delà d'une date donnée (ex: 2023-06-02T12:40:00+0100 ou 2023-06-02)
createdAt[lte]: filtrer sur les lieux créés avant une date donnée (ex: 2023-06-02T12:40:00+0100 ou 2023-06-02)
search: Facultatif. Recherche syntaxique permettant de filtrer le contenu
state: Filtrer sur les lieux vérifiés (1) ou non-vérifiés (0)

La réponse contient les clés suivantes:

locations: plage de lieux correspondants aux critères de la requête
total: total des lieux correspondant à la requête
after: valeur à préciser en paramètre "query" pour récupérer la plage de lieux suivante

La lecture d'un lieu sur un agenda se fait avec une requête get sur la route suivante:

/v2/agendas/{agendaUid}/locations/{locationUid}

Faire une requête head sur la même route renvoie un code 200 si le lieu existe, 404 sinon.

La réponse contient les données du lieu

L'identifiant externe peut également servir pour récuperer le détail d'un lieu. La route prend la forme suivante:

/v2/agendas/{agendaUid}/locations/ext/{extId}