adminArea - TimYi/FengHuang GitHub Wiki

请求URL

http://101.200.229.135:8080/api/admin/area

字段说明

字段分为显示和保存两部分。
保存字段会有一些关联实体的id，显示字段会把一些关联实体的内容扁平化显示。

显示字段

id:id
name:区域名
level:区域等级，枚举COUNTRY，PROV，CITY，AREA
code:区号，市一级有区号
upperArea:上级区域，id，name，level，code，upperArea       

传参字段

id:id
name:区域名
level:区域等级，枚举COUNTRY，PROV，CITY，AREA
code:区号，市一级有区号
upperAreaId:上级区域id

返回参数

{
"result": {
    "totalCount": 4,
    "totalPages": 1,
    "page": 1,
    "size": 8,
    "result": [
        {
            "id": "404040e64e2a016a014e2a0179d10000",
            "name": "福建",
            "level": "PROV",
            "code": null
        },
        {
            "id": "404040e64e2a016a014e2a017a2f0001",
            "name": "厦门",
            "level": "CITY",
            "code": "0592"
        },
        {
            "id": "404040e64e2a016a014e2a017a5e0003",
            "name": "北京",
            "level": "PROV",
            "code": null
        },
        {
            "id": "404040e64e2a016a014e2a017a7e0004",
            "name": "北京",
            "level": "CITY",
            "code": "010"
        }
    ]
},
"status": "OK"
}

按区域等级获取所有区域

url:http://101.200.229.135:8080/api/admin/area/level/{level}
method:GET
请求参数：level：路径参数，区域等级，枚举COUNTRY，PROV，CITY，AREA
返回：该等级下所有区域
注：会返回所有级联的下级区域
示例：
{
"result": [
    {
        "name": "福建",
        "level": "PROV",
        "code": null,
        "underAreas": [
            {
                "name": "厦门",
                "level": "CITY",
                "code": "0592",
                "underAreas": []
            }
        ]
    },
    {
        "name": "北京",
        "level": "PROV",
        "code": null,
        "underAreas": [
            {
                "name": "北京",
                "level": "CITY",
                "code": "010",
                "underAreas": []
            }
        ]
    }
],
"status": "OK"
}

按区域等级获取所有区域

url:http://101.200.229.135:8080/api/admin/area/upper/{id}
method:GET
请求参数：id：路径参数，上级区域id
返回：上级区域所有下级区域