Documentation technique

v002/referentiel/selections-par-objet

Point d’entrée

  • méthode : GET (pour utilisation JSONP) / POST – application/x-www-form-urlencoded
  • url : /v002/referentiel/selections-par-objet/
  • paramètres :
  1. query : la représentation au format JSON de la requête (cf Format de la requete ci-dessous)
  2. callback : nom de la fonction de callback (uniquement en GET pour utilisation JSONP)

Format de la requête

La requête est un objet à sérialiser en JSON.

Le schéma JSON de la requête est disponible sur cette page (fichier apiReferentielSelectionsParObjetRequete.schema).

On y trouve les champs suivants :

apiKey

  • description : clé d’API
  • type : chaîne de caractères
  • où trouver l’information : clé d’API
  • exemple :
"apiKey" : "tosdkjaq_csnqè"

projetId

  • description : identifiant du projet
  • type : entier
  • où trouver l’information : sur la fiche Apidae du projet
  • attention : il faut que la clé d’API et l’identifiant de site web correspondent
  • exemple :
"projetId" : 123

referenceIds

  • description : les identifiants des objets touristiques dont vous voulez récupérer les sélections. Si plusieurs objets touristiques sont spécifiées, on applique un opérateur OU entre elles. Si des identifiants d’objet touristique n’appartenant pas à votre membre sont dans la liste, ils sont ignorés. Si la liste est nulle ou vide, toutes les sélections de votre site web sont retournées.
  • type : liste d’entiers.
  • où trouver l’information : disponible dans les objets touristiques ou dans les urls de l’interface web
  • exemple :
"referenceIds":[ 4089965, 4500685 ]

Exemple de requête au format JSON :

{
    "projetId" : 123,

    "apiKey" : "tosdkjaq_csnqè",

    "referenceIds":[ 4089965, 4500685 ]
}

Format de sortie

La réponse est un tableau de sélections sérialisé en JSON.

Le schéma JSON de la réponse est disponible sur cette page (fichier apiReferentielSelectionsParObjetResultat.schema)

Exemple de résultat (2 sélections) :

[{
  "selections": [
     {
       "id": 1812,
       "libelle": {
         "libelleFr": "Hotels"
       },
       "nom": "Hotels"
     }
  ],
  "referenceId": 97852
}, {
  "selections": [
    {
      "id": 1658,
      "libelle": {
        "libelleFr": "Restaurants
      },
      "nom": "Restaurants"
    }
  ],
  "referenceId": 104568
}]

Cas d’erreur

  • Erreur 40x : erreur dans la requête ; le corps de la réponse HTTP contient le message d’erreur au format texte.
  • Erreur 50x : erreur de traitement ; le corps de la réponse HTTP contient le message d’erreur au format texte.