Documentation technique

v002/membre/get-by-id/

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

Aperçu
avec tous les paramètres

/v002/membre/get-by-id/{id}?apiKey={apiKey}&projetId={projetId}&responseFields=[field_1,field_2 …]

Exemple

/v002/membre/get-by-id/1234?apiKey=XXXX&projetId=12345&responseFields=["UTILISATEURS","OBJETS_GERES","PROJETS","RELATIONS","TRADUCTIONS","TAGS","COMMUNES"]
 

Cas 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

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"
        }   ]
}