Récupérez un membre à partir de son identifiant.
/v002/membre/get-by-id/{id}?&apiKey={apiKey}&projetId={projetId}
Description
Méthode GET
{id} est l’identifiant numérique de l’objet à récupérer
apiKey : clé d’API
projetId : identifiant du projet
responseFields (optionnel) : liste des champs supplémentaires de la réponse. Valeurs acceptées :
UTILISATEURS, OBJETS_GERES, PROJETS, RELATIONS, TRADUCTIONS, TAGS, COMMUNES
userStatus (optionnel) : ACTIFS (par défaut), INACTIFS ou TOUS
Cet appel liste uniquement les utilisateurs du membre (et non pas les utilisateurs enregistrés ou parrainés).
Aperçu avec tous les paramètres
/v002/membre/get-by-id/{id}?apiKey={apiKey}&projetId={projetId}&responseFields=[field_1,field_2 …]&userStatus=TOUS
Exemple
/v002/membre/get-by-id/1234?apiKey=XXXX&projetId=12345&responseFields=["UTILISATEURS","OBJETS_GERES","PROJETS","RELATIONS","TRADUCTIONS","TAGS","COMMUNES"]&userStatus=TOUSCas d’erreur
Erreur 403 : Accès interdit
Erreur 404 : membre non trouvé ; 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.
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
Attention : le nœud « niveauDiffusion » a été retiré des API dans la version 1.41 en janvier 2023.
Exemple de réponse
[
{
"id":1157,
"nom":"Membre",
"urlLogo":"http://api.apidae-tourisme.com/filestore/membres/logo-membres/1157.jpg",
"niveauDiffusion":"STANDARD",
"joursFeries": "FRANCE",
"devise":"EUR",
"type":{
"id":233,
"nom":"Contributeur Généraliste"
},
"secteur":{
"id":1,
"nom":"Hors secteurs",
"description":"Secteur de test"
},
"notifications": {
"notificationsApiExports": {
"eMails": "info@apidae-tourisme.com"
},
"notificationsGestionObjets": {
"eMails": "info@apidae-tourisme.com"
}
},
"relations":{
"parraines":[
{
"idMembre":1,
"nomMembre":"nom"
}
]
},
"permissions": [
"CONTRIBUTEUR",
"GESTIONNAIRE_PARRAINAGE_CONSULTATION",
"GESTIONNAIRE_PARRAINAGE_SAISIE",
"DIFFUSEUR_API_EXPORTS",
"GESTIONNAIRE_CRITERE_INTERNE",
"GESTIONNAIRE_IMPORTS",
"GESTIONNAIRE_API_ECRITURE",
"GESTIONNAIRE_INTEGRATION_MAPPING",
"PRESTATAIRE_API_ECRITURE",
"GESTIONNAIRE_TRADUCTION",
"GESTIONNAIRE_ASPECTS",
"GESTIONNAIRE_DONNEES_PRIVEES",
"GESTIONNAIRE_TERRITOIRES",
"PRESTATAIRE_TECHNIQUE",
"TRADUCTEUR",
"STATISTICIEN"
],
"typesGeres": [
{
"nom": "ACTIVITE",
"codeV1": "ACT",
"codeTif": "02.01.01"
},
{
"nom": "RESTAURATION",
"codeV1": "RES",
"codeTif": "02.01.13"
}
],
"tags":[
{
"idCategorie":1,
"nomCategorie":"Test categorie",
"tagsDetails":[
{
"idTag":1,
"nomTag":"Test tag"
}
]
}
],
"metadonnees": [
{
"nodeId": "nom-du-noeud"
},
{
"nodeId": "nom-autre-noeud"
}
],
"entitesJuridiques":[
{
"id":123456,
"nom":"Test",
"identifier":"Test",
"entitePrincipale":true
}
],
"utilisateurs":[
{
"id":1234,
"nom":"Test",
"prenom":"Test",
"eMail":"test@laposte.net",
"statut":"ACTIF",
permissions: [
"GESTIONNAIRE_OBJETS",
"VALIDEUR_OBJETS",
"GESTIONNAIRE_PARRAINAGE_CONSULTATION",
"GESTIONNAIRE_PARRAINAGE_SAISIE",
"GESTIONNAIRE_SAISIE_PRESTATAIRE",
"PRESTATAIRE_TECHNIQUE",
"CREATEUR_PROJET",
"GESTIONNAIRE_PROJET",
"AFFECTATION_CRITERES_INTERNES",
"GESTIONNAIRE_IMPORT",
"VALIDEUR_IMPORT",
"VALIDEUR_API_ECRITURE",
"PRESTATAIRE_API_ECRITURE",
"GESTIONNAIRE_CONTRAT_TRADUCTION",
"GESTIONNAIRE_TRADUCTION",
"ADMINISTRATEUR_CHAMPS_PRIVES",
"GESTIONNAIRE_DONNEES_PRIVEES",
"TRADUCTEUR",
"ADMIN_LOCAL",
"ADMIN_DEPARTEMENTAL",
"ADMIN_SECTEUR",
"CREATEUR_TERRITOIRE",
"ADMIN_FONCTIONNEL",
"ADMIN_GLOBAL",
"SIGN_IN_AS"
],
"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"
]
}
],
"traductions":[
{
"id": 123,
"nom": "Mon super contrat de traduction",
"langue": "nl",
"traducteur": {
"idMembre": 1234,
"nomMembre": "Mon Traducteur génial"
}
}
],
"objetsGeres":[
{
"id":123456,
"nom":"Test",
"identifier":"Test",
"type":"STRUCTURE"
}
],
"informationsEdition": {
"dateCreation": "2012-05-07T12:56:46.490+0000",
"dateModification": "2019-09-30T09:47:17.008+0000",
"utilisateurModification": {
"idUtilisateur": 1234,
"nomUtilisateur": "Nom Utilisateur",
"prenomUtilisateur": "Prenom"
}
},
"parrain": {
"id": 1,
"nom": "Auvergne - Rhône-Alpes Tourisme"
}
}
]