User review Settings¶
The user review entity contains information regarding reviews on this user. It is basically configuration on how to fetch reviews from an external provider, and currently only supported for dealers. The settings here are only shown on the website when the user has bought the feature Klantscore . Information on buying features can be found at buy-feature.
Fields¶
field | type | constraints | default | Req | W | U |
---|---|---|---|---|---|---|
reviewsPlatform | string | max. 150 chars, tevreden or klantenvertellen |
yes | yes | yes | |
reviewsUser | string | max. 100 chars | yes | yes | yes |
reviewsPlatform
The platform used for external reviews. This should either be tevreden
or klantenvertellen
reviewsUser
The user id of the dealer on the dealer reviews site.
Reference¶
GET /v1/users/{userId}/reviews-settings
Get user review settings
PUT /v1/users/{userId}/reviews-settings
Update a user’s review settings
PATCH /v1/users/{userId}/reviews-settings
Do a partial update of a user’s review settings
Errors¶
http | error code | description |
---|---|---|
400 | validation-failure | Validation of the user-review settings failed.
|
Field errors¶
field | error code | error value | description |
---|---|---|---|
<field name> | input-invalid | The value for this field is invalid. | |
<field name> | input-too-long | the maximum allowed length | The length of the supplied value exceeds the maximum allowed length for this field |
<field name> | missing-required-field | A required field is missing or empty (while that is not allowed). |
Examples¶
Retrieving the reviews for a user:
Request:
GET /v1/users/1/reviews HTTP/1.1 Host: api.marktplaats.nlResponse
HTTP/1.1 200 OK Content-Type: application/json { "_links": { "self": { "href":"/v1/users/1/reviews" }, "describedby": { "href":"https://api.marktplaats.nl/docs/v1/user-reviews.html" }, }, "_embedded": { "mp:user-review":[ { "platform":"klantenvertellen", "name":"Vrouw", "place":"Bilthoven", "date":"2014-0-12", "reason":"Evaluatie aanschaf gebruikte auto/occasion", "overallScore": 8, "content":"De autoverkoper was erg behulpzaam" "subScores":[ { "description":"klantgerichtheid", "score": 8.2 }, { "description":"nazorg", "score":9.1 } ] } ] } "numberOfReviews": 10 "averageScore": 5.8 "averageSubScores": [ { "description":"klantgerichtheid", "score": 8.2 }, { "description":"nazorg", "score": 9.1 } ] }
Retrieving the settings for reviews :
Request :
GET /v1/users/1/reviews-settings HTTP/1.1 Host: api.marktplaats.nlResponse :
HTTP/1.1 200 OK Content-Type: application/json { "_links": { "self": { "href":"/v1/users/1/reviews-settings" }, "describedby": { "href":"https://api.marktplaats.nl/docs/v1/user-reviews-settings.html" }, }, "reviewsPlatform": "tevreden", "reviewsUser": "handyHarry" }