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",
       "COMMUNES"
   ],
   "filter":{
      "nom":"nom",
      "idParrain":12,
      "communeCodePostal":"69000",
      "communeCode":"69001",
      "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
COMMUNES

Cet appel liste uniquement les utilisateurs du membre (et non pas les utilisateurs enregistrés ou parrainés).

filter : paramétrés de recherche, au format JSON

• nom (optionnel) : nom du membre à récupérer
• idParrain (optionnel) : identifiant du membre parrain
• communeCodePostal (optionnel) : code postal de la commune au format chaîne (attention aux guillemets)
• communeCode (optionnel) : code INSEE de la commune 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
• userStatus (optionnel) : ACTIFS (par défaut), INACTIFS ou TOUS

Exemple

/v002/membre/get-membres?query={"projetId":1234,"apiKey":"xxxx","responseFields":["UTILISATEURS","OBJETS_GERES","PROJETS","RELATIONS","TRADUCTIONS","COMMUNES"],"filter":{"nom":"nom","idParrain":12,"communeCodePostal":"69000″,"communeCode":"69001″,"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