Documentation technique

Formats de réponse

Cette page liste les différents formats de sortie utilisés par les API Apidae pour les services recherche et agenda.

Régles générales

Tous les résultats sont au format JSON.

Par souci de lisibilité et de compacité :

  • les champs dont la valeur est nulle ou vide ne sont pas affichés dans le flux. Ceci est valable aussi bien pour les données des objets touristiques que pour les métadonnées associées aux résultats.
  • pour les données des objets touristiques, les champs sont systématiquement filtrés. Ce filtrage est configuré au niveau de la requête.
  • les objets liés aux objets touristiques sont présentés dans un format compact spécifique.

> Documentation sur le format des objets liés
> Documentation sur le filtrage des champs
> Documentation sur le filtrage des langues

Champs communs à tous les résultats

query

Il s’agit d’un rappel de la recherche effectuée en entrée. Le format utilisé est le même que celui utilisé pour la requête.

La recherche indiquée est la recherche telle qu’elle a été interprétée par le serveur. En l’occurence, les valeurs par défaut sont indiquée dans cette valeur. Observer cette valeur et la comparer à la recherche transmise dans votre requête peut vous aider à débugguer vos appels (vérification que tous les critères ont été pris en compte, …)

> Documentation sur le format des recherches

numFound

Le nombre total de résultats trouvés pour la requête (particulièrement utile pour exploiter la pagination). Il s’agit d’un entier positif.

"numFound" : 1346
formatVersion

Version utilisée par le flux. La version étant complètement déterminée par l’url de service utilisée, il s’agit juste d’un champ de vérification. L’appel à un service v002 ne peut pas fournir de résultat au format v001.

"formatVersion" : "v002"

Champs spécifique recherche et agenda simple

objetTouristiqueIds
Services */list-identifiants

Il s’agit d’une liste d’entiers. Ces entiers sont les identifiants des objets touristiques correspondant au résultat. Ces identifiants sont triés conformément au tri demandé dans la requête.

Ces résultats sont paginés. Il s’agit donc d’un extrait de la liste des résultats déterminé par les paramètres first et count de la requête.

"objetTouristiqueIds":[ 14330, 153897, 209514 ]
objetsTouristiques
Services */list-objets-touristiques

Similaire au résultat précédent, les identifiants sont remplacés par les données des objets touristiques correspondants.

"objetsTouristiques":
[
    objet1,
    objet2,
    objet3,
    objet4
]

objet1, objet2, objet3 sont des objets json représentant les objets touristiques du résultat.

Champs spécifiques agenda détaillé

objetTouristiqueIds
Services */list-identifiants

Il s’agit d’un tableau mettant en correspondance pour chaque date du résultat la liste des objets touristiques ouverts ce jour et correspondant à la recherche. Ces entiers sont les identifiants des objets touristiques correspondant au résultat. Au sein de chaque journée, ces identifiants sont triés conformément au tri demandé dans la requête.

Ces résultats sont paginés. Il s’agit donc d’un extrait de la liste des résultats déterminé par les paramètres first et count de la requête.
S’il n’y a aucun objet ouvert un jour donné, la date n’apparaît pas dans le résultat.
Un objet ouvert plusieurs jours est listé plusieurs fois dans le résultat.

"objetTouristiqueIds":
{
    "2012-08-01" : [ 209514, 229079 ],
    "2012-08-02" : [ 209514, 229079, 230640, 230659 ],
    "2012-08-03" : [ 209514, 229079, 230640, 230659, 239781 ],
    "2012-08-04" : [ 209514, 229079 ],
    "2012-08-05" : [ 229079 ]
}
objetsTouristiques
Services */list-objets-touristiques

Similaire au résultat précédent, les identifiants sont remplacés par les données des objets touristiques correspondants.

"objetsTouristiques":
{
    "2012-08-01" : [ objet1, objet2 ],
    "2012-08-02" : [ objet1, objet2, objet3, objet4 ],
    "2012-08-03" : [ objet1, objet3, objet4 ],
    "2012-08-04" : [ objet1, objet3 ],
    "2012-08-05" : [ objet3 ]
}

objet1, objet2, objet3 sont des objets json représentant les objets touristiques du résultat.