获取城市信息

Developing

测试环境

https://tapi.antong56.com:8443/antong-api/api-platform

POST

/api/baseData/v2/getCityList

城市信息查询；省份名称和省份编码必填其中一项；

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://tapi.antong56.com:8443/antong-api/api-platform/api/baseData/v2/getCityList' \
--header 'token: undefined' \
--header 'salt;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parentNo": "P020",
    "parentName": "广东省",
    "searchName": "汕尾市",
    "searchNo": "441500000000"
}'

Response Example

{
    "state": "ok",
    "code": 20000,
    "msg": null,
    "errorMsg": null,
    "result": [
        {
            "name": "福州",
            "number": "350100000000",
            "parentName": "福建"
        },
        {
            "name": "厦门市",
            "number": "350200000000",
            "parentName": "福建"
        },
        {
            "name": "莆田市",
            "number": "350300000000",
            "parentName": "福建"
        },
        {
            "name": "三明市",
            "number": "350400000000",
            "parentName": "福建"
        },
        {
            "name": "泉州市",
            "number": "34",
            "parentName": "福建"
        },
        {
            "name": "漳州市",
            "number": "350600000000",
            "parentName": "福建"
        },
        {
            "name": "南平市",
            "number": "350700000000",
            "parentName": "福建"
        },
        {
            "name": "龙岩市",
            "number": "350800000000",
            "parentName": "福建"
        },
        {
            "name": "宁德市",
            "number": "350900000000",
            "parentName": "福建"
        }
    ],
    "responseOk": true
}

Request

Header Params

token

string

token令牌

必需

示例值:

salt

string

13位毫秒值时间戳

必需

sign

string

必需

数字签名，对salt + appSecret拼接字符串后使用国密SM3算法加密，生成16进制sign

Body Params application/json

searchName

string

城市名称

可选

searchNo

string

城市编码

可选

parentName

string

省份名称

可选

省份名称和省份编码必填其中一项

parentNo

string

省份编码

可选

Examples

Responses

🟢200成功

application/json

Body

state

string

状态

必需

成功 ok；失败 fail；

code

integer

状态值

必需

成功 20000；其余为失败；

msg

string

消息文字

必需

errorMsg

string

报错信息

必需

responseOk

boolean

状态

必需

成功 true；失败 false；

result

array [object {3}]

返回结果集

必需

name

string

城市中文名称

必需

number

string

城市编号

必需

parentName

string

省份名称

必需

Modified at 2025-06-09 07:46:28

获取省份列表

获取区县信息