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

BETA

Returns the list of zones, in hierarchy (state > county > city), where the customer has properties. customerId is resolved from the access token.

Resource information
Authentication	Required (API Token, Bearer)
HTTP Method	GET
Response	JSON
Version	1
Cache	1 day

Resource URL

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

Parameters

This endpoint does not receive parameters.

Sample code

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}

Response

Object	Field	Type	Required	Description
Response	states	Array of State	yes	The list of states where the customer has properties
State	description	string	yes	State/province description
	id	int	yes	State/province ID (zone1)
	counties	Array of County	no	Counties (or second geographic division) within the state
County	description	string	yes	County description
	id	int	yes	County ID (zone2)
	cities	Array of City	no	Cities/neighborhoods within the county
City	description	string	yes	City/neighborhood description
	id	int	yes	City/neighborhood ID (zone3)

Sample response

{
    "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 }
                    ]
                }
            ]
        }
    ]
}