Override Amenities Scores
PUT
override/scores/amenities
Override amenities scores for provided dossierId
Request#
Example Request 1#
curl -X PUT 'https://api.pricehubble.com/api/v1/override/scores/amenities' \
-H 'content-type: application/json' \
-H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
-d '{
"dossierId": "598e38d1-e075-479f-9bba-dec8b3939c67",
"scores": {
"family": null,
"shopping": 0.1
},
"countryCode": "CH"
}'
Override shopping value, reset family value to default, don't update other scores
Example Request 2#
curl -X PUT 'https://api.pricehubble.com/api/v1/override/scores/amenities' \
-H 'content-type: application/json' \
-H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
-d '{
"dossierId": "598e38d1-e075-479f-9bba-dec8b3939c67",
"scores": {
"family": null,
"shopping": null
},
"countryCode": "CH"
}'
Reset override score for shopping and family. Don't update other scores
Field | Description | Type | Remarks |
---|---|---|---|
dossierId | Dossier unique id | string | |
countryCode | ISO country code | string | Valid values are AT , BE , CH , CZ , DE , FR , JP , NL and SK |
scores | scores object | object | |
scores.catering | override catering score | min: 0.0 (very bad) max: 1.0 (very good) |
|
scores.family | override family score | min: 0.0 (very bad) max: 1.0 (very good) |
|
scores.health | override health score | min: 0.0 (very bad) max: 1.0 (very good) |
|
scores.leisure | override leisure score | min: 0.0 (very bad) max: 1.0 (very good) |
|
scores.shopping | override shopping score | min: 0.0 (very bad) max: 1.0 (very good) |
Response#
{
"dossierId": "598e38d1-e075-479f-9bba-dec8b3939c67",
"countryCode": "CH",
"scores": {
"catering": null,
"family": null,
"health": null,
"leisure": null,
"shopping": 0.1
}
}
Field | Description | Type | Remarks |
---|---|---|---|
dossierId | Dossier unique id | string | |
countryCode | ISO country code | string | |
scores | scores object | object | |
scores.catering | overridden catering score | min: 0.0 (very bad) max: 1.0 (very good) or null if score is not overridden |
|
scores.family | overridden family score | min: 0.0 (very bad) max: 1.0 (very good) or null if score is not overridden |
|
scores.health | overridden health score | min: 0.0 (very bad) max: 1.0 (very good) or null if score is not overridden |
|
scores.leisure | overridden leisure score | min: 0.0 (very bad) max: 1.0 (very good) or null if score is not overridden |
|
scores.shopping | overridden shopping score | min: 0.0 (very bad) max: 1.0 (very good) or null if score is not overridden |