v002/collaborateurs/

Cet appel API sert à lister les membres propriétaires et collaborateurs sur une ou plusieurs offres touristiques.

Point d’entrée

  • méthode : GET (pour utilisation JSONP) / POST – application/x-www-form-urlencoded
  • url : /v002/collaborateurs/
  • paramètres :
  1. query : la représentation au format JSON de la requête (cf. Format de la requête 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 apiMembresCollaborateursRequete.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" : "s34WSq8"

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 à retourner. Si plusieurs objets sont spécifiés, on applique un opérateur OU entre eux. Si la liste est nulle ou vide, aucun membre collaborateur n’est retourné.
  • type : liste d’entiers.
  • exemple :
"referenceIds":[ 5163353, 4659645 ]

Exemple de requête au format JSON :

{
    "apiKey": "s34WSq8",
    "projetId": "123",
    "referenceIds": [5163353,4659645]
}

Format de sortie

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

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

Attention, le nombre d’objets touristiques retournés par ce service est limité à 200. Cette limitation a été délibérément mise en place pour éviter les abus.

Exemple de résultat (1 objet touristique) :

[
    {
        "referenceId": 5163353,
        "membreProprietaire": 1157,
        "membresCollaborateurs": [
            6,
            96,
            171,
            684,
            1080,
            1182,
            1185
        ]
    }
]

Cas d’erreur

  • Erreur 40x : dépassement de la limite des 200 offres, droits insuffisants, objet touristique non trouvé, 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 ou membre déjà présent / non présent sur l’offre ; le corps de la réponse HTTP contient le message d’erreur au format texte.