描述
获取地址数据源。
请求
URL
HTTP请求方式
GET
HTTP请求参数
名称 | 是否必需 | 类型 | 描述 |
---|---|---|---|
parentId | 否 | String | 父区域。默认空,表示获取所有国家。 |
响应
- 返回参数
返回地址区域数组,地址区域数据项参数说明:
名称 | 类型 | 描述 |
---|---|---|
Id | String | 区域Id。 |
Name | String | 区域名称。 |
ParentId | String | 所属父区域Id。 |
ChildCount | Integer | 子区域数。 |
Depth | Integer | 区域所属层次。 |
PostCode | String | 区域编码。 |
OrderIndex | Integer | 排序索引。 |
示例
请求示例
GET /v1/data/areas?parentId=A0860000 HTTP/1.1
Host: api.dadayun.cn
Date: Thu, 30 Aug 2018 02:55:22 GMT
正常返回示例
HTTP/1.1 200 OK
Date: Thu, 30 Aug 2018 02:55:22 GMT
Content-Type: application/json; charset=utf-8
[
{
"Id": "11000000",
"Name": "北京市",
"ParentId": "A0860000",
"ChildCount": 1,
"Depth": 0,
"PostCode": "",
"OrderIndex": 11
},
{
"Id": "12000000",
"Name": "天津市",
"ParentId": "A0860000",
"ChildCount": 1,
"Depth": 0,
"PostCode": "",
"OrderIndex": 12
},
....
]