Get Region List

Last Updated on : 2023-06-20 14:54:07download

Get a list of regions based on the entered city ID.

API address

GET: /v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities/{city_id}/areas

Request parameter

Parameter name	Type	IN	Required	Description
infrared_id	String	uri	true	The device ID.
province_id	Long	uri	true	The ID of a specified province.
city_id	Long	uri	true	The ID of a specified city.

Return parameter

Parameter name	Type	Description
result	List

Description of result

Parameter name	Type	Description
province_id	Long	The ID of a specified province.
city_id	Long	The ID of a specified city.
area_id	Long	The ID of a specified region.
area_name	String	The name of a specified region.

Request example

GET: /v2.0/infrareds/vdevo15345926009****/provinces/120000/cities/120100/areas

Return example

{
    "result": [
        {
            "area_name": "Heping District",
            "area_id": 120101,
            "province_id": 120000,
            "city_id": 120100
        }
    ],
    "t": 1630917924107,
    "success": true
}

Error code

For more information, see error code.