Voici la liste des services accessibles aux projets de diffusion API de Apidae.
Objet touristique
Le schéma JSON d’un résultat de requête est disponible sur cette page.
Ces services permettent de récupérer les informations d’un seul objet touristique de manière simple.
- v001/objet-touristique/get-by-id – récupération par id
- v001/objet-touristique/get-by-identifier – récupération par identifier
L’existence d’un identifiant / id et d’un identifier est un héritage historique de Apidae. Les deux peuvent être utilisés. Nous conseillons d’utiliser le champ id.
Recherche d’objets touristiques
Le schéma JSON d’un résultat de requête est disponible sur cette page.
Ces services permettent de récupérer les objets touristiques respectant une requête de recherche. Les deux services utilisent le même format de requête. La sortie propose soit une liste d’identifiants, soit une liste d’objets.
- v001/recherche/list-identifiants/ – récupération d’une liste d’identifiants
- v001/recherche/list-objets-touristiques/ – récupération d’une liste d’objets
Documentation du format de la requête
Agenda
Seuls les objets de type « Fête et manifestation » sont pris en compte par ce type de recherche.
Les objets sont regroupés par date d’évènement. Un objet touristique qui se déroule sur plusieurs journées est listé plusieurs fois dans le résultat (une fois pour chaque jour d’ouverture).
Prenons l’exemple de deux événements :
Fete_Et_Manifestation_1 se déroulant du 04/09/2012 au 07/09/2012,
Fete_Et_Manifestation_2 se déroulant du 06/09/2012 au 10/09/2012
Une recherche agenda du 05/09/2012 au 08/09/2012 nous renverra un résultat de la forme :
05/09/2012 : Fete_Et_Manifestation_1
06/09/2012 : Fete_Et_Manifestation_1, Fete_Et_Manifestation_2
07/09/2012 : Fete_Et_Manifestation_1, Fete_Et_Manifestation_2
08/09/2012 : Fete_Et_Manifestation_2
Comme pour la recherche d’objets classique, il existe deux services, l’un pour récupérer les identifiants des objets, l’autre pour récupérer les objets eux-même :
- v001/agenda/list-identifiants/ – récupération d’une liste d’identifiants
- v001/agenda/list-objets-touristiques/ – récupération d’une liste d’objets
Documentation du format de la requête
Consultation du référentiel
Ces services sont à votre disposition pour récupérer les éléments du référentiel :
- v001/referentiel/communes/ – récupération de communes
- v001/referentiel/elements-reference/ – récupération d’éléments de référence
- v001/referentiel/criteres-internes/ – récupération de critères internes
- v001/referentiel/selections/ – récupération de sélections
Ces services ne sont pas conçus pour obtenir l’intégralité du référentiel, mais uniquement pour récupérer de petits ensembles d’éléments que vous aurez au préalable identifiés.