/v1/discovery/get_best_places
#Parámetros
| Nombre | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
citySlug |
string |
si |
— |
Canonical city slug from /v1/discovery/get_cities. |
categorySlug |
string |
No |
"" |
Optional canonical category, such as restaurants. |
pageSize |
int |
No |
10 |
Number of results, 1-25. |
pageNumber |
int |
No |
0 |
Zero-based page, 0-20. |
Ejemplo de solicitud (cURL)
curl --get \
'https://es.appointmenttrader.com/v1/discovery/get_best_places' \
--data-urlencode 'key={{API_KEY}}' \
--data-urlencode 'citySlug={{citySlug}}' \
--data-urlencode 'categorySlug={{categorySlug}}' \
--data-urlencode 'pageSize={{pageSize}}' \
--data-urlencode 'pageNumber={{pageNumber}}'
Respuesta
JSON Campos de respuesta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
$ | discovery_get_best_places_Response |
si | |
$.oneOf[0] | |
si | |
$.oneOf[0].allOf[0] | object |
si | |
$.oneOf[0].allOf[0].RequestUserAlias | string |
si | |
$.oneOf[0].allOf[0].RequestPath | string | null |
si | |
$.oneOf[0].allOf[0].RequestStatus | = "Succeeded" |
si | |
$.oneOf[0].allOf[0].ResponseCode | integer |
si | |
$.oneOf[0].allOf[0].ResponseMessage | APIResponseMessage |
si | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0] | string | number | boolean | null |
si | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1] | array |
si | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][] | APIResponseMessage |
No | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2] | object |
si | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].* | APIResponseMessage |
No | |
$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias | string |
No | |
$.oneOf[0].allOf[1] | object |
si | |
$.oneOf[0].allOf[1].Payload | object |
si | |
$.oneOf[0].allOf[1].Payload.city | object |
si | |
$.oneOf[0].allOf[1].Payload.city.cityName | |
si | |
$.oneOf[0].allOf[1].Payload.city.cityName.anyOf[0] | string |
si | |
$.oneOf[0].allOf[1].Payload.city.cityName.anyOf[1] | null |
si | |
$.oneOf[0].allOf[1].Payload.city.citySlug | string |
si | |
$.oneOf[0].allOf[1].Payload.city.countryCode | |
si | |
$.oneOf[0].allOf[1].Payload.city.countryCode.anyOf[0] | string |
si | |
$.oneOf[0].allOf[1].Payload.city.countryCode.anyOf[1] | null |
si | |
$.oneOf[0].allOf[1].Payload.city.isoRegion | |
No | |
$.oneOf[0].allOf[1].Payload.city.isoRegion.anyOf[0] | string |
No | |
$.oneOf[0].allOf[1].Payload.city.isoRegion.anyOf[1] | null |
No | |
$.oneOf[0].allOf[1].Payload.city.stateShort | |
No | |
$.oneOf[0].allOf[1].Payload.city.stateShort.anyOf[0] | string |
No | |
$.oneOf[0].allOf[1].Payload.city.stateShort.anyOf[1] | null |
No | |
$.oneOf[0].allOf[1].Payload.places | array |
si | |
$.oneOf[0].allOf[1].Payload.places[] | object |
No | |
$.oneOf[0].allOf[1].Payload.places[].locationAlias | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].name | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].cityName | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].citySlug | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].countryCode | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].categorySlug | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].address | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].url | string |
si | |
$.oneOf[0].allOf[1].Payload.places[].rank | integer |
si | |
$.oneOf[0].allOf[1].Payload.places[].locationID | integer |
si | |
$.oneOf[0].allOf[1].Payload.rankingBasis | = "AppointmentTrader city hotlist" |
si | |
$.oneOf[0].allOf[1].Payload.rankingCacheSeconds | = 86400 |
si | |
$.oneOf[0].allOf[1].Payload.availabilityIncluded | = false |
si | |
$.oneOf[0].allOf[1].Payload.checkedAt | string |
si | |
$.oneOf[0].allOf[1].Payload.pagination | object |
si | |
$.oneOf[0].allOf[1].Payload.pagination.pageSize | integer |
si | |
$.oneOf[0].allOf[1].Payload.pagination.pageNumber | integer |
si | |
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber | |
si | |
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[0] | integer |
si | |
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[1] | null |
si | |
$.oneOf[0].allOf[1].Payload.pagination.hasMore | boolean |
si | |
$.oneOf[0].allOf[1].Payload.pagination.refineSearch | boolean |
si | |
$.oneOf[1] | object |
si | |
$.oneOf[1].RequestUserAlias | string |
si | |
$.oneOf[1].RequestPath | string | null |
si | |
$.oneOf[1].RequestStatus | = "Failed" |
si | |
$.oneOf[1].ResponseCode | integer |
si | |
$.oneOf[1].ResponseMessage | APIResponseMessage |
si | |
$.oneOf[1].ResponseMessage.oneOf[0] | string | number | boolean | null |
si | |
$.oneOf[1].ResponseMessage.oneOf[1] | array |
si | |
$.oneOf[1].ResponseMessage.oneOf[1][] | APIResponseMessage |
No | |
$.oneOf[1].ResponseMessage.oneOf[2] | object |
si | |
$.oneOf[1].ResponseMessage.oneOf[2].* | APIResponseMessage |
No | |
$.oneOf[1].RequestImpersonatedByUserAlias | string |
No |
Ejemplo de respuesta
{
"RequestStatus": "Succeeded",
"ResponseCode": 100,
"ResponseMessage": "Synthetic success example.",
"RequestPath": "/v1/discovery/get_best_places",
"RequestUserAlias": "example-user",
"Payload": {
"city": {
"cityName": "synthetic-example",
"citySlug": "synthetic-example",
"countryCode": "synthetic-example"
},
"places": [],
"rankingBasis": "AppointmentTrader city hotlist",
"rankingCacheSeconds": 86400,
"availabilityIncluded": false,
"checkedAt": "2030-01-01T12:00:00Z",
"pagination": {
"pageSize": 1,
"pageNumber": 0,
"nextPageNumber": 1,
"hasMore": false,
"refineSearch": false
}
}
}