文档帮助中心
dsc.region.list.get (获取地区列表API)
获取地区列表API，获取地区相关信息。
公共参数
请求地址：
公共请求参数：
| 环境 | HTTP请求地址 | HTTPS请求地址 |
|---|---|---|
| 正式环境 | https://www.xxx.com/api.php | https://www.xxx.com/api.php |
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | String | 是 | API接口名称 |
| app_key | String | 是 | API接口AppKey |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 更多限制 | 描述 |
|---|---|---|---|---|---|
| parent_id | Number | 可选 | 父级ID | ||
| region_type | Number | 可选 | 地区层级 | ||
| page | Number | 可选 | 1 | 默认 | 列表分页当前页 |
| page_size | Number | 可选 | 15 | 默认 | 列表分页每页显示条数 |
| format | type | 必须 | json | json或xml | 接口类型 |
响应参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| region_id | Number | 地区ID | |
| parent_id | Number | 父级ID | |
| region_name | String | 地区名称 | |
| region_type | Number | 地区层级（0：国家；1：省份；2：市级；3：县级地区；4：乡镇街道） | |
| agency_id | Text | 办事处的ID |
请求示例
PHP
$Http->doGet($url);
$Http = new Http();
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.region.list.get&format=xml"
错误码解释
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| error | 返回值 | 0：成功获取数据 1：数据为空值 |
