API接口文档

地区

创建于 2021-07-27 / 最近更新于 2021-07-27 / 583

简要描述

获取地区节点数据

接口版本

版本号 制定人 制定日期 修订日期
1.0.0 Devil 2020-03-03

请求URL

region/index

请求方式

POST

公共参数

参数名 是否必须 类型 默认值 描述
application string web 请求应用、参考公共中详解
application_client_type string pc 请求客户端、参考公共中详解
token string token

请求参数

参数名 是否必须 类型 默认值 描述
pid int 0 地区父级 id

返回示例

正确时返回

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "id": "1",
            "name": "北京市",
            "level": "1",
            "letters": ""
        },
        {
            "id": "2",
            "name": "天津市",
            "level": "1",
            "letters": ""
        },
        {
            "id": "3",
            "name": "河北省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "4",
            "name": "山西省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "5",
            "name": "内蒙古自治区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "6",
            "name": "辽宁省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "7",
            "name": "吉林省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "8",
            "name": "黑龙江省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "9",
            "name": "上海市",
            "level": "1",
            "letters": ""
        },
        {
            "id": "10",
            "name": "江苏省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "11",
            "name": "浙江省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "12",
            "name": "安徽省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "13",
            "name": "福建省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "14",
            "name": "江西省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "15",
            "name": "山东省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "16",
            "name": "河南省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "17",
            "name": "湖北省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "18",
            "name": "湖南省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "19",
            "name": "广东省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "20",
            "name": "广西壮族自治区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "21",
            "name": "海南省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "22",
            "name": "重庆市",
            "level": "1",
            "letters": ""
        },
        {
            "id": "23",
            "name": "四川省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "24",
            "name": "贵州省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "25",
            "name": "云南省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "26",
            "name": "西藏自治区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "27",
            "name": "陕西省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "28",
            "name": "甘肃省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "29",
            "name": "青海省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "30",
            "name": "宁夏回族自治区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "31",
            "name": "新疆维吾尔自治区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "32",
            "name": "台湾省",
            "level": "1",
            "letters": ""
        },
        {
            "id": "33",
            "name": "香港特别行政区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "34",
            "name": "澳门特别行政区",
            "level": "1",
            "letters": ""
        },
        {
            "id": "35",
            "name": "海外",
            "level": "1",
            "letters": ""
        },
        {
            "id": "36",
            "name": "其它",
            "level": "1",
            "letters": ""
        }
    ]
}

错误时返回

{
    "msg": "success",
    "code": 0,
    "data": []
}

返回参数说明 -> data

参数名 是否必须 类型 描述
id int 地区 id
name string 地区名称
level int 级别类型(1:一级[所有省], 2:二级[所有市], 3:三级[所有区县], 4:街道[所有街道])
letters string 地区首字母

备注

更多返回错误代码请看首页的错误代码描述

0 人点赞过