Documentation technique

Schémas JSON

Vous trouverez sur cette page l’ensemble des schémas JSON utilisés.

Schémas complets

Dernière version des schémas : https://github.com/apidae-tourisme/apidae-sit-schemas/

API v2 API v2

Dernière version des schémas : https://github.com/apidae-tourisme/apidae-sit-schemas/tree/main/v002/api/output

Exports v2 Exports v2

Dernière version des schémas : https://github.com/apidae-tourisme/apidae-sit-schemas/tree/main/v002/export/output

API v1 API v1

Dernière version des schémas : https://github.com/apidae-tourisme/apidae-sit-schemas/tree/main/v001/api/output

Exports v1 Exports v1

Dernière version des schémas : https://github.com/apidae-tourisme/apidae-sit-schemas/tree/main/v001/export/output

Format des objets touristiques

Dernière version des schémas : https://github.com/apidae-tourisme/apidae-sit-schemas/tree/main/v002/api/full/objetTouristique

Description des schémas

Les schémas fournis utilisent la version draft v3 de la spécification json schema. L’utilisation de cette version est obligatoire car elle permet de traiter des listes polymorphes.
Il est nécessaire d’utiliser une description de liste polymorphe pour la liste de résultats des objets touristiques (la liste contient des objets pouvant être de 16 types différents).

Les schémas fournis sont générés de manière stricte : « additionalProperties » est déterminé à false sur tous les éléments.
Nous vous conseillons d’ignorer ce paramètre si vous ne désirez pas déclencher une erreur quand de nouveaux champs sont ajoutés aux résultats d’API.

Précisions sur les fichiers

  • API apiObjetsTouristiquesRequete.schema : schéma d’une requête de recherche (pour la requête d’une recherche)
  • API apiObjetsTouristiquesResultat.schema : schéma d’une réponse à une recherche (pour les résultats de requête de recherche)
  • API objetTouristique/*.schema : schéma par type d’objet (pour les requêtes individuelles)
  • API apiReferentielCommunes(Requete|Resultat).schema : schéma d’une requête/du résultat pour la récupération de communes.
  • API apiReferentielElementsReference(Requete|Resultat).schema : schéma d’une requête/du résultat pour la récupération d’éléments de référence.
  • API apiReferentielCriteresInternes(Requete|Resultat).schema : schéma d’une requête/du résultat pour la récupération de critères internes.
  • API apiReferentielSelections(Requete|Resultat).schema : schéma d’une requête/du résultat pour la récupération de sélections.
  • Exports exportCommunes.schema
  • Exports exportCriteresInternes.schema
  • Exports exportElementsReference.schema
  • Exports exportObjetsTouristiques.schema : schéma des objets touristiques dans le cas où les objets sont groupés en lot.
  • Exports exportSelections.schema
  • Exports exportTerritoire.schema

Limitation du schéma

Le schéma fournit ne permet pas de traiter les résultats des interrogations sur le service d’agenda. En effet, les réponses du service agenda utilisent une représentation de type hashmap ; json schéma ne permet pas de représenter ce type de résultat.