Avis détaillés sur une fiche
Objectif
Cette méthode permet de récupérer les avis détaillés sur une fiche. Un avis détaillé contient les champs questions, criterias et pictures en plus d’un avis simplifié.
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/detailed_reviews/:id?private_key=:private_key
Exemple : https://api.monaviscompte.fr/detailed_reviews/794173?private_key=efr9-kk7p-ah68-j9nw
Paramètres
nom | requis | type | description |
---|---|---|---|
id | oui | int | identifiant de la fiche |
private_key | oui | string | clé d’authentification privée |
sort_type | non | string | méthode de tri, date ou grade |
max_review_limit | non | int | nombre maximal d’avis retournés. Par défaut : 10. Utilisé conjointement avec reviews_from_index, permet la pagination. |
reviews_from_index | non | int | indice du premier avis à afficher. Par défaut : 0. Utilisé conjointement avec max_review_limit, permet la pagination. |
Données retournées
nom | type | description |
---|---|---|
my_reviews | list | liste des avis de la fiche |
my_reviews_count | int | nombre d’avis de la fiche |
Les éléments review sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
title | string | titre de l’avis |
body | string | corps de l’avis |
date | date | date de dépôt de l’avis au format YYYY-MM-DD |
username | string | nom d’utilisateur de l’auteur |
grade | int | moyenne des réponses au questionnaire entre 0 et 5 |
satisfaction | int | satisfaction de l’avis entre 0 et 5 |
recommendation | int | recommandation de l’avis entre 0 et 10 |
experience_date_from | date | date de l’expérience au format YYYY-MM-DD |
public_business_reply | PublicBusinessReply | réponse publique de la marque |
criterias | Criterias | questions du propriétaire de la fiche |
questions | Questions | questions du questionnaire de cette fiche |
pictures | Pictures | photos associées à l’avis |
Les éléments PublicBusinessReply sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
value | string | contenu de la réponse |
date | date | date de la réponse au format YYYY-MM-DD |
satisfaction | string | satisfaction de l’utilisateur concernant cette réponse, parmi not_satisfied, unknown et satisfied |
Les éléments Criteria sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
id | int | identifiant unique de la question |
title | string | titre de la question |
grade | float | note attribuée par l’auteur à la question, entre 0 et 5 |
reviews_count | int | inutilisé |
Les éléments Question sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
id | int | identifiant unique de la question |
title | string | titre de la question, peut être null pour les questions les plus anciennes |
content | string | texte de la question |
grade | float | note attribuée par l’auteur à la question, entre 0 et 5 |
Les éléments Picture sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
url | string | URL de la photo |
filename | string | nom original de la photo |
Code de retour
code de retour | raison |
---|---|
HTTP 200 | succès |
HTTP 401 | authentification échouée |
HTTP 404 | la fiche n’existe pas |
Réponse JSON
{
"my_reviews"
: [
{
"username"
:
"karinedet"
,
"date"
:
"2013-07-14"
,
"body"
:
"un gout traditionnel qui ne bouge pas d'année en année un prix abordable"
,
"title"
:
"un gout traditionnel "
,
"recommendation"
: 8,
"grade"
: 4.6,
"satisfaction"
: 5,
"public_business_reply"
: {
"value"
:
"Merci pour votre remarque, nous allons régler ce point."
,
"date"
:
"2013-07-16"
,
"satisfaction"
:
"unkown"
},
"criterias"
: [
{
"id"
: 322,
"title"
:
"Nouvelle organisation du magasin"
,
"grade"
: 4.4
},
{
"id"
: 323,
"title"
:
"Réductions du mois de juillet"
,
"grade"
: 3.7,
}
],
"questions"
: [
{
"id"
: 322,
"title"
:
"Rapport qualité/prix"
,
"content"
:
"Le rapport qualité/prix"
,
"grade"
: 2.4
},
{
"id"
: 323,
"title"
:
"Accueil en magasin"
,
"content"
:
"L'accueil dans notre magasin"
,
"grade"
: 1.7,
}
],
"experience_date_from"
:
"2013-07-14"
},
{
"username"
:
"matdan"
,
"date"
:
"2013-05-31"
,
"body"
:
""
,
"title"
:
"rien ne vaut 1 vrai coca !!",
"recommendation"
: 10,
"grade"
: 4.9,
"satisfaction"
: 5,
"public_business_reply"
:
null
,
"criterias"
: [
{
"id"
: 322,
"title"
:
"Nouvelle organisation du magasin"
,
"grade"
: 4.4
},
{
"id"
: 323,
"title"
:
"Réductions du mois de juillet"
,
"grade"
: 3.7,
}
],
"questions"
: [
{
"id"
: 322,
"title"
:
"Rapport qualité/prix"
,
"content"
:
"Le rapport qualité/prix"
,
"grade"
: 2.4
},
{
"id"
: 323,
"title"
:
"Accueil en magasin"
,
"content"
:
"L'accueil dans notre magasin"
,
"grade"
: 1.7,
}
],
"experience_date_from"
:
"1990-05-06"
},
],
"my_reviews_count"
: 2
}
Réponse XML
<
reviews
>
<
my_reviews
>
<
review
>
<
body
>un gout traditionnel qui ne bouge pas d'année en année un prix abordable</
body
>
<
date
>2013-07-14</
date
>
<
experience_date_from
>2013-07-14</
experience_date_from
>
<
grade
>4.6</
grade
>
<
recommendation
>8</
recommendation
>
<
public_business_reply
>
<
date
>2013-07-16</
date
>
<
satisfaction
>unknown</
satisfaction
>
<
value
>
Merci pour votre remarque, nous allons régler ce point.
</
value
>
</
public_business_reply
>
<
criterias
>
<
criteria
>
<
grade
>4.4</
grade
>
<
id
>322</
id
>
<
title
>Nouvelle organisation du magasin</
title
>
</
criteria
>
<
criteria
>
<
grade
>3.7</
grade
>
<
id
>323</
id
>
<
title
>Réduction du mois de juillet</
title
>
</
criteria
>
</criterias>
<
questions
>
<
question
>
<
grade
>2.4</
grade
>
<
id
>322</
id
>
<
title
>Rapport qualité/prix</
title
>
<
content
>Le rapport qualité/prix</
content
>
</
question
>
<
question
>
<
grade
>1.7</
grade
>
<
id
>323</
id
>
<
title
>Accueil en magasin</
title
>
<
content
>L'accueil fait en magasin</
content
>
</
question
>
</questions>
<
satisfaction
>5</
satisfaction
>
<
title
>un gout traditionnel </
title
>
<
username
>karinedet</
username
>
</
review
>
<
review
>
<
body
></
body
>
<
date
>2013-05-31</
date
>
<
experience_date_from
>1990-05-06</
experience_date_from
>
<
grade
>4.9</
grade
>
<
recommendation
>10</
recommendation
>
<
public_business_reply
>null</public_business_reply>
<
criterias
>
<
criteria
>
<
grade
>4.4</
grade
>
<
id
>322</
id
>
<
title
>Nouvelle organisation du magasin</
title
>
</
criteria
>
<
criteria
>
<
grade
>3.7</
grade
>
<
id
>323</
id
>
<
title
>Réduction du mois de juillet</
title
>
</
criteria
>
</criterias>
<
questions
>
<
question
>
<
grade
>2.4</
grade
>
<
id
>322</
id
>
<
title
>Rapport qualité/prix</
title
>
<
content
>Le rapport qualité/prix</
content
>
</
question
>
<
question
>
<
grade
>1.7</
grade
>
<
id
>323</
id
>
<
title
>Accueil en magasin</
title
>
<
content
>L'accueil fait en magasin</
content
>
</
question
>
</questions>
<
satisfaction
>5</
satisfaction
>
<
title
>rien ne vaut 1 vrai coca !!</
title
>
<
username
>matdan</
username
>
</
review
>
</
my_reviews
>
<
my_reviews_count
>2</
my_reviews_count
>
</
reviews
>