HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防系统管理模块 / 省市区字典-根据城市code获取所有区域
省市区字典-根据城市code获取所有区域
接口地址:https://api.iot.ink/api/app.php?s=Manage.Admin_DicCityData_GetfindAreasByCityCode.Api
接口描述: 省市区字典-根据城市code获取所有区域
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
code | 字符串 | 必须 | - | 城市code 示例420100 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | |
data.data | 数组 | |
data.data>>code | 字符串 | 区域code |
data.data>>name | 字符串 | 区域名称 |
data.data>>parentCode | 字符串 | |
data.data>>post | 字符串 | |
data.data>>level | 字符串 | |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
code | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"data": [
{
"code": "420102",
"name": "江岸区",
"parentCode": "420100",
"post": "430014",
"level": 3
},
{
"code": "420103",
"name": "江汉区",
"parentCode": "420100",
"post": "430015",
"level": 3
},
{
"code": "420104",
"name": "硚口区",
"parentCode": "420100",
"post": "430033",
"level": 3
},
{
"code": "420105",
"name": "汉阳区",
"parentCode": "420100",
"post": "430050",
"level": 3
},
{
"code": "420106",
"name": "武昌区",
"parentCode": "420100",
"post": "430061",
"level": 3
},
{
"code": "420107",
"name": "青山区",
"parentCode": "420100",
"post": "430080",
"level": 3
},
{
"code": "420111",
"name": "洪山区",
"parentCode": "420100",
"post": "430070",
"level": 3
},
{
"code": "420112",
"name": "东西湖区",
"parentCode": "420100",
"post": "430040",
"level": 3
},
{
"code": "420113",
"name": "汉南区",
"parentCode": "420100",
"post": "430090",
"level": 3
},
{
"code": "420114",
"name": "蔡甸区",
"parentCode": "420100",
"post": "430100",
"level": 3
},
{
"code": "420115",
"name": "江夏区",
"parentCode": "420100",
"post": "430200",
"level": 3
},
{
"code": "420116",
"name": "黄陂区",
"parentCode": "420100",
"post": "430300",
"level": 3
},
{
"code": "420117",
"name": "新洲区",
"parentCode": "420100",
"post": "431400",
"level": 3
},
{
"code": "420118",
"name": "其它区",
"parentCode": "420100",
"post": "",
"level": 3
}
]
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-24 22:06:11