Documentation technique

v001/referentiel/selections/

Point d’entrée

  • méthode : GET (pour utilisation JSONP) / POST – application/x-www-form-urlencoded
  • url : /v001/referentiel/selections/
  • 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 apiReferentielSelectionsRequete.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è"

siteWebExportIdV1

  • 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 :
"siteWebExportIdV1" : 123

selectionIds

  • description : les identifiants des sélections à retourner. Il vous est possible de récupérer des sélections appartenant à votre membre. Si plusieurs sélections sont spécifiées, on applique un opérateur OU entre elles. Si des identifiants de sélections 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 : dans le menu Diffuser > Projets > Mes sélections (voir les outils pour les développeurs) ou dans les fichiers d’export.
  • exemple :
"selectionIds":[ 64, 5896 ]

Exemple de requête au format JSON :

{
    "siteWebExportIdV1" : 123,

    "apiKey" : "dfl87jq5",

    "selectionIds":[ 64, 5896 ]
}

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 apiReferentielSelectionsResultat.schema).

NOTA : le résultat contient seulement la liste des sélections pour le site web indiqué. Pour obtenir le contenu d’une sélection, il faut utiliser le service de recherche avec l’identifiant de sélection désiré.

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

[ {
  "id" : 3759,
  "nom" : "Festivals"
}, {
  "id" : 3760,
  "nom" : "Randonnées depuis St Christophe en Oisans"
} ]

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.