dsc.region.update.post (更新地区信息API)

更新地区信息API,获取地区相关信息。

公共参数

请求地址:
环境 HTTP请求地址 HTTPS请求地址
正式环境 http://www.xxx.com/api.php https://www.xxx.com/api.php
公共请求参数:
名称 类型 是否必须 描述
method String API接口名称
app_key String API接口AppKey

请求参数

名称 类型 是否必须 示例值 更多限制 描述
region_id Number 可选 (唯一性) 地区ID
region_name String 可选 (唯一性) 地区名称
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(json格式)
  • PHP(xml格式)
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.region.update.post&format=json"
$Http = new Http();
 
$data=array(
'parent_id' => '1',
'region_name' => '北京',
'region_type' => '1',
'agency_id' => '0'
)
 
$data = json_encode($data); // 对变量进行 JSON 编码
$argument=array(
'region_id' => '4',
'data' => $data
)
 
$Http->doPost($url, $argument);
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.region.update.post&format=xml"
$Http = new Http();
 
$data = '<?xml version="1.0" encoding="utf-8"?>
<dsc>
<parent_id>1</parent_id>
<region_name>北京</region_name>
<region_type>1</region_type>
<agency_id>0</agency_id>
</dsc>';
 
$data = htmlspecialchars($data); // 将特殊字符转换为 HTML 实体
$argument = array(
'region_id' => '4',
'data' => $data
);
 
$Http->doPost($url, $argument);

异常示例

  • XML
  • JSON
<dsc>
<result>success</result>
<error>0</error>
<msg>数据更新成功</msg>
</dsc>
{
"result": "success",
"error": 0,
"msg": "数据更新成功",
}

错误码解释

错误码 错误描述 解决方案
error 返回值

0:数据更新成功

1:数据提交失败,参数不存在

2:条件为空或参数不存在

3:已存在相同数据,无法更新

4:当前数据不存在

5:存在不可传参的参数

返回
顶部