GET /api/action/mapaprop-chat-ai-v1/zones

BETA

Retorna a listagem de zonas, em hierarquia (estado > município > cidade), onde o cliente tem propriedades. customerId é resolvido a partir do access token.

Informações do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Método HTTP	GET
Resposta	JSON
Versão	1
Cache	1 dia

URL do recurso

https://mapaprop.app/api/action/mapaprop-chat-ai-v1/zones

Parâmetros

Este endpoint não recebe parâmetros.

Código de exemplo

GET /api/action/mapaprop-chat-ai-v1/zones HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	states	Array of State	sim	A lista de estados onde o cliente tem propriedades
State	description	string	sim	Descrição do estado
	id	int	sim	ID do estado (zone1)
	counties	Array of County	não	Municípios (ou segunda divisão geográfica) dentro do estado
County	description	string	sim	Descrição do município
	id	int	sim	ID do município (zone2)
	cities	Array of City	não	Cidades/bairros dentro do município
City	description	string	sim	Descrição da cidade/bairro
	id	int	sim	ID da cidade/bairro (zone3)

Exemplo de resposta

{
    "states": [
        {
            "description": "Capital Federal",
            "id": 1,
            "counties": [
                { "description": "Palermo", "id": 46 },
                { "description": "Belgrano", "id": 93 }
            ]
        },
        {
            "description": "Buenos Aires",
            "id": 2,
            "counties": [
                {
                    "description": "San Isidro",
                    "id": 300,
                    "cities": [
                        { "description": "Boulogne", "id": 2896 }
                    ]
                }
            ]
        }
    ]
}