Liste des utilisateurs
Objectif
Cette méthode permet de récupérer l’ensemble des utilisateurs ayant laissé un avis sur l’une de vos fiches.
Format de réponse
Par défaut, l’API offre une réponse au format JSON. Pour bénéficier d’une réponse en XML, vous devez placer dans votre requête un header de type « Accept » avec la valeur « application/xml ».
Signature
GET https://api.monaviscompte.fr/users?private_key=:private_key
Exemple : https://api.monaviscompte.fr/users?private_key=efr9-kk7p-ah68-j9nw
Paramètres
nom | requis | type | description |
---|---|---|---|
private_key | oui | string | clé d’authentification privée |
max_user_limit | non | int | nombre maximal d’utilisateurs retournés. Par défaut : 10. Utilisé conjointement avec users_from_index, permet la pagination. |
users_from_index | non | int | indice du premier utilisateur à afficher. Par défaut : 0. Utilisé conjointement avec max_user_limit, permet la pagination. |
Données retournées
nom | type | description |
---|---|---|
my_users | list | liste de vos utilisateurs |
my_users_count | int | nombre d’utilisateurs dont vous pouvez récupérer les informations |
Les éléments user sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
id | int | identifiant de l’utilisateur |
first_name | string | prénom de l’utilisateurs |
last_name | string | nom de l’utilisateur |
string | email de l’utilisateur | |
login | string | identifiant monaviscompte de l’utilisateur |
title | string | civilité de l’utilisateur (parmi MR, MRS, MISS) |
birth_date | date | date de naissance au format yyyy-mm-dd |
registration_date | date | date de l’inscription au format yyyy-mm-dd |
address | string | adresse de l’utilisateur |
phone_number | string | numéro de téléphone de l’utilisateur |
review_count | int | nombre d’avis total déposé par l’utilisateur |
Code de retour
code de retour | raison |
---|---|
HTTP 200 | succès |
HTTP 401 | authentification échouée |
Réponse JSON
{
"my_users"
: [
{
"id"
:
"1"
,
"title"
:
"MR"
,
"first_name"
:
"Prénom"
,
"last_name"
:
"Nom"
,
"login"
: "Login",
"email"
: "email@email.com",
"birth_date"
: "1970-01-01",
"address"
: "address",
"registration_date"
: "2014-01-01",
"phone_number"
: "+33xxxxxxxxx",
"review_count"
: "10",
}
],
"my_users_count"
: "1"
}
Réponse XML
<
users
>
<
my_users
>
<
user
>
<
id
>1</id>
<title>MR</title>
<first_name>Prénom</first_name>
<last_name>Nom</last_name>
<login>Login</login>
<email>email@email.com</email>
<birth_date>1970-01-01</birth_date>
<registration_date>2014-01-01</registration_date>
<review_count>10</review_count>
<phone_number>+33xxxxxxxxx</phone_number>
</
user
>
</
my_users
>
<
my_users_count
>1</
my_users_count
>
</
users
>