Cómo buscar destinos de actividades
Antes de buscar actividades, necesita un destinationId. El punto final de autocompletar le permite buscar destinos por nombre y devuelve resultados coincidentes con los ID necesarios para todas las llamadas API posteriores.
Punto final
POST {{api_host}}/api/ext/activity/destinations
encabezados
| Encabezado | Requerido | Descripción |
|---|---|---|
x-api-key | Sí | Su clave API de Xeni |
Content-Type | Sí | application/json |
Cuerpo de solicitud
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
text | cadena | Sí | La consulta de búsqueda. Mínimo 2 caracteres. |
Solicitud de ejemplo
JSON
{
"text": "las vegas"
}Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
status | booleano | Si la solicitud fue exitosa. |
data | matriz | Lista de destinos coincidentes. |
data[].destinationId | cadena | Identificador único del destino. Utilice esto en consultas de búsqueda y etiquetas. |
data[].destinationName | cadena | Nombre corto del destino (por ejemplo, "Las Vegas"). |
data[].destinationType | cadena | El tipo de destino (por ejemplo, "CIUDAD", "REGIÓN"). |
data[].destinationCountry | cadena | País donde se encuentra el destino. |
data[].fullName | cadena | Nombre para mostrar completo, incluida la región y el país. |
isActivityName | booleano | Indica si la búsqueda coincidió con un nombre de actividad en lugar de un destino. |
Ejemplo de respuesta
JSON
{
"status": true,
"data": [
{
"destinationId": "737",
"destinationName": "Las Vegas",
"destinationType": "CITY",
"destinationCountry": "United States",
"fullName": "Las Vegas, Nevada, United States"
}
],
"isActivityName": false
}Notas de uso
- El parámetro
textdebe tener al menos 2 caracteres. Las consultas más cortas no arrojarán resultados. - El indicador
isActivityNameen la respuesta indica si la coincidencia se basa en un nombre de destino o en un nombre de actividad. Esto puede ayudarle a ajustar su interfaz de usuario en consecuencia. - Guarde el
destinationIdde la respuesta; lo necesitará para recuperar etiquetas y buscar actividades.
Próximos pasos
Una vez que tenga un destinationId, podrá recuperar las etiquetas de filtro disponibles para ese destino. Consulte Cómo buscar etiquetas y categorías de actividad.