Documentation technique

Référentiels (v1)

De manière à classifier l’information Apidae, les fiches d’objets touristiques sont agrémentées de champs exploitant un référentiel commun à l’ensemble du réseau. Cette page explicite le format utilisé pour les référentiels.

Eléments de référence

Les éléments de référence constituent l’essentiel du référentiel Apidae. Ils permettent de catégoriser les objets touristiques selon un nombre important de thématiques.
Outils développeurs / Consultation des référentiels

API

Dans les flux API, un élément de référence est répresenté de la manière suivante.
Les champs parent et familleCritere sont facultatifs.
Les champs libelle* (libelleFr, libelleEn, …) sont présents en fonction du paramétrage des langues adoptés.

Les éléments de référence désactivés sont filtrés et ne sont pas inclus dans le flux des API.

{
	        "elementReferenceType" : "ActiviteSportivePrestation",
	        "id" : 2013,
	        "libelleFr" : "Randonnée équestre",
	        "ordre" : 139,
	        "familleCritere" : {
	              "elementReferenceType" : "FamilleCritere",
	              "id" : 59,
	              "code" : "1000.06.24",
	              "libelleFr" : "Sports équestres",
	              "ordre" : 105
	        },
	        "parent" : {
	              "elementReferenceType" : "ActiviteSportivePrestation",
	              "id" : 1865,
	              "code" : "02.01.01.02.139",
	              "libelleFr" : "Sports équestres",
	              "ordre" : 131
	        }
	}

> Documentation sur le filtrage par langue
> Service de consultation du référentiel

Exports

Dans les flux d’export, le référentiel étant disponible dans les fichiers exportés, les éléments de référence sont représentés sous une forme compacte.

Les informations complètes sont disponibles dans les fichiers de référentiel disponibles dans l’export.

Certains éléments de référence exportés peuvent être désactivés ; il faut consulter dans le référentiel le champ actif pour savoir si un élément de référence est actif ou non (ce qui détermine s’il doit être affiché).

{
	        "elementReferenceType" : "ActiviteSportivePrestation",
	        "id" : 2013
	}

> Documentation sur le format de l’archive d’export

Communes (adresse, périmètre géographique)

Les communes peuvent être référencées dans les champs localisation.adresse.commune ou localisation.perimetreGeographique.

Le champ localisation.adresse.commune correspond à la commune principale associée à l’objet, en particulier à son adresse postale.

Le champ localisation.perimetreGeographique correspond à un ensemble de communes auxquelles l’objet touristique est lié. Pour le territoire, le champ correspond aux communes concernées par le territoire. Pour les autres types d’objet, il s’agit de l’ensemble des communes pour lesquelles la recherche par commune permet d’obtenir des résultats.

De manière générale, le champ code de la commune correspond au code INSEE de la commune. Cependant, pour les communes étrangères ou les communes « fictives » nécessaires par exemple pour les stations de ski, le code est un identifiant choisi de manière arbitraire. Vous pouvez consulter le référentiel des communes dans l’application Apidae.

> Outils développeurs / Consultation des référentiels

API

Format de la commune dans les API.

{
  "id" : 5,
  "code" : "01006",
  "nom" : "Ambléon",
  "pays" : {
    "id" : 532,
    "elementReferenceType" : "Pays",
    "id" : 532,
    "libelleFr" : "France",
    "libelleEn" : "France",
    "libelleEs" : "Francia",
    "libelleIt" : "Francia",
    "libelleDe" : "FRANKREICH",
    "libelleNl" : "FRANKRIJK",
    "ordre" : 78
  },
  "codePostal" : "01300"
}

Exports

Format de la commune dans les exports.

Les informations complètes sont disponibles dans les fichiers de référentiel disponibles dans l’export.

{
  "id" : 14748
}