K12服务体系技术规范 API接口说明

公共-地区列表

URL:/common/area_list

请求方式:GET

Headers:

参数 说明
Authorization access_token访问令牌

响应:

名称 类型 说明
status int 状态
msg char 返回信息
region_id int 地区id
p_region_id int 上级地区id
code int 地区行政编码
name char 地区名称

返回的结果示例:

成功返回:

{
    "list": [
        {
            "region_id": 2623,
            "p_region_id": 0,
            "code": 511500,
            "region_name": "宜宾市"
        },
        {
            "region_id": 2624,
            "p_region_id": 2623,
            "code": 511501,
            "region_name": "市辖区"
        },
        {
            "region_id": 2625,
            "p_region_id": 2623,
            "code": 511502,
            "region_name": "翠屏区"
        },
        {
            "region_id": 2626,
            "p_region_id": 2623,
            "code": 511503,
            "region_name": "南溪区"
        }                     
    ]
}

失败返回:

{
    "status": <ErrorCode>,
    "msg": <ErrorMessage>
}