dsc.region.list.get (获取地区列表API)

获取地区列表API，获取地区相关信息。

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://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

请求示例

$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.region.list.get&format=xml"

$Http = new Http();

$Http->doGet($url);

响应示例

XML
JSON

<dsc>

<info>

<list>

<region_id>1</region_id>

<parent_id>0</parent_id>

<region_name>中国</region_name>

<region_type>0</region_type>

<agency_id>0</agency_id>

</item>

<region_id>2</region_id>

<parent_id>1</parent_id>

<region_name>北京</region_name>

<region_type>1</region_type>

<agency_id>0</agency_id>

</item>

</list>

</info>

<page_size>15</page_size>

<record_count>3418</record_count>

<page_count>277</page_count>

</filter>

<page_count>277</page_count>

<record_count>3418</record_count>

</dsc>

{

"info": {

"list": [{

"region_id": "1",

"parent_id": "0",

"region_name": "中国",

"region_type": "0",

"agency_id": "0",

{

"region_id": "2",

"parent_id": "1",

"region_name": "北京",

"region_type": "1",

"agency_id": "0",

}],

"filter": {

"page": 1,

"page_size": 15,

"record_count": 3418,

"page_count": 277

"page_count": 277,

"record_count": 3418

}

异常示例

XML
JSON

<dsc>

<result>success</result>

<msg>成功获取数据</msg>

</dsc>

{

"result": "success",

"error": 0,

"msg": "成功获取数据",

}

错误码解释

错误码	错误描述	解决方案
error	返回值	0：成功获取数据 1：数据为空值

错误码

错误描述

解决方案

error

返回值

0：成功获取数据

1：数据为空值

返回
顶部

大商创开放平台

地区API