Documentation technique

v002/membre/get-membres/

Recherche d’un membre.

/v002/membre/get-membres

Description
Méthode GET (JsonP)
Méthode POST (application/x-www-form-urlencoded)

query : la représentation au format JSON de la requête

Paramètre query

{
   "projetId":1234,
   "apiKey":"xxxx",
   "responseFields":[
      "UTILISATEURS",
      "OBJETS_GERES",
      "PROJETS",
      "RELATIONS",
      "TRADUCTIONS",
      "TAGS",
      "COMMUNES"
   ],
   "filter":{
      "nom":"nom",
      "idParrain":12,
      "communeCode":"69000",
      "types":[
         "type1",
         "type2"
      ],
      "idProjet":1234,
      "typeProjet":"type",
      "statutProjet":"DEVELOPPEMENT",
      "idSecteur":123,
      "nomSecteur":"secteur"
   }
}

projetId : identifiant du projet associé à la clé d’API

apiKey : clé d’API

responseFields (optionnel) : liste des champs supplémentaires de la réponse. Valeurs acceptées :
UTILISATEURS
OBJETS_GERES
PROJETS
RELATIONS
TRADUCTIONS
TAGS
COMMUNES

filter : paramétrés de recherche

nom (optionnel) : nom du membre à récupérer

idParrain (optionnel) : identifiant du membre parrain

communeCode (optionnel) : code de la commune (INSEE ou code postal) au format chaîne (attention aux guillemets)

types (optionnel) : types de membre (Contributeur Généraliste, Diffuseur Institutionnel, Prestataire Technique, etc.)

idProjet (optionnel) : identifiant du projet du membre recherché

typeProjet (optionnel) : type du projet (Site internet, Application ou site Mobile, Borne d’information, Intégration ponctuelle de données, Ecriture de métadonnées, Usages print et e-brochure, Synchronisation en écriture avec une plateforme tiers, Alimentation d’un autre système informatique, Autre type de projet, Panneaux d’information ou Apidae Connect (SSO))

statutProjet (optionnel) : statut du projet (DEMONSTRATION, DEVELOPPEMENT, NON_DETERMINE ou PRODUCTION)

idSecteur (optionnel) : identifiant du secteur

nomSecteur (optionnel) : nom du secteur

Exemple

/v002/membre/get-membres?query={"projetId":1234,"apiKey":"xxxx","responseFields":["UTILISATEURS","OBJETS_GERES","PROJETS","RELATIONS","TRADUCTIONS","TAGS","COMMUNES"],"filter":{"nom":"nom","idParrain":12,"communeCode":"69000″,"types":["type1″,"type2″],"idProjet":1234,"typeProjet":"type","statutProjet":"DEVELOPPEMENT","idSecteur":123,"nomSecteur":"secteur"}}
 

Cas d’erreur

Erreur 403 : Accès interdit
Erreur 50x : erreur de traitement ; le corps de la réponse HTTP contient le message d’erreur au format texte.

Permissions

Accès limité aux API de lecture : permet de voir exclusivement les champs « id », « nom », « niveauDiffusion », « devise », « type », « secteur », « urlLogo » et « descriptifCommercial »
Accès aux API de lecture : permet de voir toutes les informations du membre

Exemple de réponse

[
   {
      "id":1157,
      "nom":"Membre",
      "niveauDiffusion":"STANDARD",
      "devise":"EUR",
      "type":{
         "id":233,
         "nom":"Contributeur Généraliste"
      },
      "secteur":{
         "id":1,
         "nom":"Hors secteurs",
         "description":"Secteur de test"
      },
      "relations":{
         "parraines":[
            {
               "idMembre":1,
               "nomMembre":"nom"
            }
         ]
      },
      "notifications":{
         "notificationsApiExports":{
            "eMails":"api@test.com"
         },
         "notificationsGestionObjets":{
            "eMails":"gestion@test.com"
         }
      },
      "tags":[
         {
            "idCategorie":1,
            "nomCategorie":"Test categorie",
            "tagsDetails":[
               {
                  "idTag":1,
                  "nomTag":"Test tag"
               }
            ]
         }
      ],
      "entitesJuridiques":[
         {
            "id":123456,
            "nom":"Test",
            "identifier":"Test",
            "entitePrincipale":true
         }
      ],
      "utilisateurs":[
         {
            "id":1234,
            "nom":"Test",
            "prenom":"Test",
            "eMail":"test@laposte.net",
            "parraine":false
         }
      ],
      "communes":[
         {
            "id":12345,
            "nom":"Aagtekerke",
            "codePostal":"NL-4363 NB",
            "codeInsee":"ET066"
         }
      ],
      "projets":[
         {
            "id":1234,
            "nom":"Projet",
            "type":"DIFFUSION",
            "etat":"PRODUCTION",
            "statut":"PROPRIETAIRE",
            "dateDerniereGeneration":"2017-06-16T11:04:16.067+0000",
            "statutDernierExport":"ERROR",
            "technologies":[
               "API",
               "EXPORT"
            ]
         }
      ],
      "objetsGeres":[
         {
            "id":123456,
            "nom":"Test",
            "identifier":"Test",
            "type":"STRUCTURE"
         }
      ]
   }
]