Servicio de sugerencias de zonas para autocompletar una ubicación.
| Información del recurso | |
|---|---|
| Autenticación | Required |
| Método HTTP | GET |
| Respuesta | JSON |
| Versión | 1 |
URL del recurso
https://mapaprop.app/api/action/portal-v2/zones/suggestions
Parámetros
| Clave | Tipo | Requerido | Descripción |
|---|---|---|---|
| term | string | yes | Término de búsqueda, mínimo 3 caracteres |
| country | string | yes | El código ISO del país. Constantes |
| exclude | string | no | Códigos de zona a excluir de las sugerencias |
| limit | int | no | Cantidad de registros a devolver, máximo 100, por defecto 10 |
Ejemplo de llamada
GET /api/action/portal-v2/zones/suggestions?term=buenos&country=AR HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
Respuesta
Un Array JSON de sugerencias de zona, ordenadas por relevancia. No hay objeto contenedor: la respuesta es la lista.
| Objeto | Campo | Tipo | Requerido | Descripción |
|---|---|---|---|---|
| Zone | description | string | yes | La zona con sus niveles superiores, lista para mostrar |
| Zone | code | string | yes | El código completo, con el país adelante — el que se usa para filtrar |
| Zone | localCode | string | yes | El mismo código sin el país |
| Zone | seoUrl | string | yes | Su identificador en la URL |
| Zone | country | int | yes | El id del país |
| Zone | _id | string | yes | El id interno del documento |
Una misma localidad puede aparecer varias veces si existe en más de una provincia — el termpalermo devuelve Palermo, Anta, Salta y Palermo, Capital Federal. Por eso description
trae los niveles superiores: es lo que hace distinguible a cada sugerencia.
Ejemplo de respuesta
[
{
"country": 1,
"description": "General Güemes, General Güemes, Salta",
"localCode": "17-452-2534",
"seoUrl": "general-guemes-general-guemes-salta",
"code": "1-17-452-2534"
},
{
"country": 1,
"description": "General Alvear, General Alvear, Mendoza",
"localCode": "13-338-1974",
"seoUrl": "general-alvear-general-alvear-mendoza",
"code": "1-13-338-1974"
},
{
"country": 1,
"description": "General Alvear, General Alvear, Buenos Aires",
"localCode": "2-179-1431",
"seoUrl": "general-alvear-general-alvear-buenos-aires",
"code": "1-2-179-1431"
},
{
"country": 1,
"description": "General Lavalle, General Lavalle, Buenos Aires",
"localCode": "2-185-1469",
"seoUrl": "general-lavalle-general-lavalle-buenos-aires",
"code": "1-2-185-1469"
},
{
"country": 1,
"description": "General Arenales, General Arenales, Buenos Aires",
"localCode": "2-180-1432",
"seoUrl": "general-arenales-general-arenales-buenos-aires",
"code": "1-2-180-1432"
},
{
"country": 1,
"description": "General Hornos, General Las Heras, Buenos Aires",
"localCode": "2-184-1464",
"seoUrl": "general-hornos-general-las-heras-buenos-aires",
"code": "1-2-184-1464"
},
{
"country": 1,
"description": "General Guido, General Guido, Buenos Aires",
"localCode": "2-182-1450",
"seoUrl": "general-guido-general-guido-buenos-aires",
"code": "1-2-182-1450"
},
{
"country": 1,
"description": "General Rodriguez, General Rodriguez, Buenos Aires",
"localCode": "2-190-1065",
"seoUrl": "general-rodriguez-general-rodriguez-buenos-aires",
"code": "1-2-190-1065"
},
{
"country": 1,
"description": "General Pinto, General Pinto, Buenos Aires",
"localCode": "2-188-1477",
"seoUrl": "general-pinto-general-pinto-buenos-aires",
"code": "1-2-188-1477"
},
{
"country": 1,
"description": "General Belgrano, General Belgrano, Buenos Aires",
"localCode": "2-181-1443",
"seoUrl": "general-belgrano-general-belgrano-buenos-aires",
"code": "1-2-181-1443"
}
]