Documentation technique

v001/referentiel/criteres-internes/

Point d’entrée

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

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

critereInterneIds

  • description : les identifiants des critères internes à retourner. Si plusieurs critères internes sont spécifiés, on applique un opérateur OU entre eux. Si des identifiants de critères internes n’appartenant pas à votre membre sont dans la liste, ils sont ignorés. Si la liste est nulle ou vide, tous les critères internes de votre membre sont retournés.
  • type : liste d’entiers.
  • où trouver l’information : dans le menu Diffuser > Outils développeur > Référentiel > Critères internes (voir les outils pour les développeurs) ou dans les fichiers d’export.
  • exemple :
"critereInterneIds":[ 1068, 2168 ]

Exemple de requête au format JSON :

{
    "siteWebExportIdV1" : 123,
    "apiKey" : "dfl87jq5",
    "critereInterneIds":[ 1068, 2168 ]
}

Format de sortie

La réponse est un tableau de critères internes sérialisé en JSON.

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

Exemple de résultat (2 critères internes) :

[ {
  "id" : 1068,
  "libelle" : "exemple critère 1"
}, {
  "id" : 2168,
  "libelle" : "exemple critère 2",
  "commentaire" : "commentaire pertinent à propos du critère 2"
} ]

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.