接口功能介绍
查询城市信息。
接口约束
无
URI
POST /v1/area/city/*
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 省份信息vcCode字段 | 1010301 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码CTCSSCN_000000 :成功;CTCSSCN_000001:失败;CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用;CTCSSCN_000004:鉴权错误;CTCSSCN_000005:用户没有付费版配额,功能不可用 | CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | data |
表 data
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
lId | Integer | id编号 | 118339 | |
eLangType | String | 语言环境 | zh_CN | |
vcName | String | 名称 | 石家庄 | |
vcCode | String | 编码 用户真正存储的编码 | 1010301 | |
eType | String | 类型 | i18n_area | |
eIsEdit | String | 是否可编辑 | null | |
vcRemark | String | vcRemark | null |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
无
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":[{"lId": 118409,"eLangType": "zh_CN","vcName": "石家庄","vcCode": "1010301","eType": "i18n_area","eIsEdit": null,"vcRemark": null}]}
状态码
请参考 状态码
错误码
请参考 错误码