作者：管理员 历史版本：1 最后编辑：龚清 更新时间：2024-11-20 15:41
获取地理区域树
简述：
- 获取地理区域树
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/findTreeData
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例：
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}返回示例：
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": [
{
"pk": "",
"name": "地理区域",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "0",
"typeId": "0",
"key": "0",
"parentId": "0",
"sn": null,
"parentName": null,
"level": -1,
"leaf": true,
"expanded": true,
"loaded": true,
"parent": true
}
]
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | List< AreaVo > | 地理区域对象信息列表 |
查询
简述：
- 根据传入id查询，并返回地理区域信息
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/get
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- GET
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| areaId | String | 是 | 地理区域id |
- Body：
暂无
请求参数示例：
http://192.168.3.230:15100/ibps/platform/v3/cat/area/get?areaId=659004返回示例：
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"pk": "",
"name": "五家渠市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "659004",
"typeId": "0",
"key": "659004",
"parentId": "6590",
"sn": 3247
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | AreaPo | 地理区域对象信息 |
查询
简述：
- 根据传入区域代码查询，并返回地理区域信息
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/getByAreaKey
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- GET
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| key | String | 是 | 区域代码 |
- Body：
暂无
请求参数示例：
http://192.168.3.230:15100/ibps/platform/v3/cat/area/getByAreaKey?key=659004返回示例：
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"pk": "",
"name": "五家渠市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "659004",
"typeId": "0",
"key": "659004",
"parentId": "6590",
"sn": 3247
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | AreaPo | 地理区域对象信息 |
获取地理区域控件数据
简述：
- 获取地理区域控件数据
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/getData
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例：
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}返回示例：
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"0": {
"AUS": "澳大利亚",
"AUT": "奥地利",
"BEL": "比利时",
"BRA": "巴西",
"CAF": "中非共和国",
"CAN": "加拿大",
"CHE": "瑞士",
"CN": "中国",
"COL": "哥伦比亚",
"DEU": "德国",
"DNK": "丹麦",
"EGY": "埃及",
"ESP": "西班牙",
"ETH": "埃塞俄比亚",
"FIN": "芬兰",
"FRA": "法国",
"GBR": "英国",
"GRC": "希腊",
"HUN": "匈牙利",
"IDN": "印度尼西亚",
"IND": "印度",
"ITA": "意大利",
"JPN": "日本",
"KHM": "柬埔寨",
"KOR": "韩国",
"LAO": "老挝",
"LKA": "斯里兰卡",
"MDV": "马尔代夫",
"MEX": "墨西哥",
"MMR": "缅甸",
"MNG": "蒙古",
"MUS": "毛里求斯",
"MYS": "马来西亚",
"NLD": "荷兰",
"NOR": "挪威",
"NPL": "尼泊尔",
"NZL": "新西兰",
"PAK": "巴基斯坦",
"PER": "秘鲁",
"PHL": "菲律宾",
"POL": "波兰",
"PRK": "朝鲜",
"PRT": "葡萄牙",
"RUS": "俄罗斯",
"SGP": "新加坡",
"SWE": "瑞典",
"THA": "泰国",
"USA": "美国",
"VNM": "越南"
},
"11": {
"1101": "北京市"
},
"12": {
"1201": "天津市"
},
"13": {
"1301": "石家庄市",
"1302": "唐山市",
"1303": "秦皇岛市",
"1304": "邯郸市",
"1305": "邢台市",
"1306": "保定市",
"1307": "张家口市",
"1308": "承德市",
"1309": "沧州市",
"1310": "廊坊市",
"1311": "衡水市"
},
"14": {
"1401": "太原市",
"1402": "大同市",
"1403": "阳泉市",
"1404": "长治市",
"1405": "晋城市",
"1406": "朔州市",
"1407": "晋中市",
"1408": "运城市",
"1409": "忻州市",
"1410": "临汾市",
"1411": "吕梁市"
},
"15": {
"1501": "呼和浩特市",
"1502": "包头市",
"1503": "乌海市",
"1504": "赤峰市",
"1505": "通辽市",
"1506": "鄂尔多斯市",
"1507": "呼伦贝尔市",
"1508": "巴彦淖尔市",
"1509": "乌兰察布市",
"1522": "兴安盟",
"1525": "锡林郭勒盟",
"1529": "阿拉善盟"
},
"21": {
"2101": "沈阳市",
"2102": "大连市",
"2103": "鞍山市",
"2104": "抚顺市",
"2105": "本溪市",
"2106": "丹东市",
"2107": "锦州市",
"2108": "营口市",
"2109": "阜新市",
"2110": "辽阳市",
"2111": "盘锦市",
"2112": "铁岭市",
"2113": "朝阳市",
"2114": "葫芦岛市"
}
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | Map<String, Object> |
获取地理区域控件数据（旧）
简述：
- 获取地理区域控件数据（旧）
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/getPickerData
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例：
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}返回示例：
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"0": {
"A-G": [
{
"address": "澳大利亚",
"code": "AUS"
},
{
"address": "奥地利",
"code": "AUT"
},
{
"address": "比利时",
"code": "BEL"
},
{
"address": "巴西",
"code": "BRA"
},
{
"address": "哥伦比亚",
"code": "COL"
},
{
"address": "德国",
"code": "DEU"
},
{
"address": "丹麦",
"code": "DNK"
},
{
"address": "埃及",
"code": "EGY"
},
{
"address": "埃塞俄比亚",
"code": "ETH"
},
{
"address": "芬兰",
"code": "FIN"
},
{
"address": "法国",
"code": "FRA"
},
{
"address": "巴基斯坦",
"code": "PAK"
},
{
"address": "菲律宾",
"code": "PHL"
},
{
"address": "波兰",
"code": "POL"
},
{
"address": "朝鲜",
"code": "PRK"
},
{
"address": "俄罗斯",
"code": "RUS"
}
]
}
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | Map<String, Object> |
查询地理区域
简述：
- 查询地理区域
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/query
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例：
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}返回示例：
{
"state": 200,
"request": null,
"message": "",
"cause": "",
"variables": {},
"data": {
"dataResult": [
{
"pk": "",
"name": "中国",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "CN",
"typeId": "country",
"key": "CN",
"parentId": "0",
"sn": 0
},
{
"pk": "",
"name": "北京市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "11",
"typeId": "0",
"key": "11",
"parentId": "CN",
"sn": 1
},
{
"pk": "",
"name": "北京市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "1101",
"typeId": "0",
"key": "1101",
"parentId": "11",
"sn": 1
},
{
"pk": "",
"name": "天津市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "1201",
"typeId": "0",
"key": "1201",
"parentId": "12",
"sn": 1
},
{
"pk": "",
"name": "上海市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "3101",
"typeId": "0",
"key": "3101",
"parentId": "31",
"sn": 1
},
{
"pk": "",
"name": "重庆市",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "5001",
"typeId": "0",
"key": "5001",
"parentId": "50",
"sn": 1
},
{
"pk": "",
"name": "东城区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110101",
"typeId": "0",
"key": "110101",
"parentId": "1101",
"sn": 2
},
{
"pk": "",
"name": "西城区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110102",
"typeId": "0",
"key": "110102",
"parentId": "1101",
"sn": 3
},
{
"pk": "",
"name": "崇文区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110103",
"typeId": "0",
"key": "110103",
"parentId": "1101",
"sn": 4
},
{
"pk": "",
"name": "宣武区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110104",
"typeId": "0",
"key": "110104",
"parentId": "1101",
"sn": 5
},
{
"pk": "",
"name": "朝阳区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110105",
"typeId": "0",
"key": "110105",
"parentId": "1101",
"sn": 6
},
{
"pk": "",
"name": "丰台区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110106",
"typeId": "0",
"key": "110106",
"parentId": "1101",
"sn": 7
},
{
"pk": "",
"name": "石景山区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110107",
"typeId": "0",
"key": "110107",
"parentId": "1101",
"sn": 8
},
{
"pk": "",
"name": "海淀区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110108",
"typeId": "0",
"key": "110108",
"parentId": "1101",
"sn": 9
},
{
"pk": "",
"name": "门头沟区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110109",
"typeId": "0",
"key": "110109",
"parentId": "1101",
"sn": 10
},
{
"pk": "",
"name": "房山区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110111",
"typeId": "0",
"key": "110111",
"parentId": "1101",
"sn": 11
},
{
"pk": "",
"name": "通州区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110112",
"typeId": "0",
"key": "110112",
"parentId": "1101",
"sn": 12
},
{
"pk": "",
"name": "顺义区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110113",
"typeId": "0",
"key": "110113",
"parentId": "1101",
"sn": 13
},
{
"pk": "",
"name": "昌平区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110114",
"typeId": "0",
"key": "110114",
"parentId": "1101",
"sn": 14
},
{
"pk": "",
"name": "大兴区",
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": "-999",
"dataStatus": null,
"dbtype": null,
"id": "110115",
"typeId": "0",
"key": "110115",
"parentId": "1101",
"sn": 15
}
],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 3300,
"totalPages": 165
}
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | APIPageList |
地理区域对象信息列表 |
删除
简述：
- 删除地理区域记录
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/remove
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| areaIds | String[] | 是 | 地理区域id数组 |
- Body：
暂无
请求参数示例：
http://192.168.3.230:15100/ibps/platform/v3/cat/area/remove?areaIds=1101返回示例：
{
"state": 200,
"request": null,
"message": "删除地理区域成功",
"cause": "",
"variables": {},
"data": null
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | Void |
保存
简述：
- 保存地理区域
请求URL：
- http://ip:port/ibps/platform/v3/cat/area/save
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| id | string | 否 | 主键 | ||
| typeId | string | 否 | 类型ID | ||
| key | string | 是 | 区域代码 | ||
| name | string | 否 | 区域名称 | ||
| parentId | string | 否 | 父ID | ||
| sn | integer | 否 | 排序 | ||
| parentName | string | 否 | 父节点名称 | ||
| level | int | 否 | 层级 | ||
| leaf | boolean | 否 | 是否叶子节点 | ||
| isParent | boolean | 否 | 是否父节点 | ||
| expanded | boolean | 否 | 是否展开 | ||
| loaded | boolean | 否 | 是否加载 |
请求参数示例：
{
"key":"1101"
}返回示例：
{
"state": 200,
"request": null,
"message": "保存地理区域成功",
"cause": "",
"variables": {
"id": "654277373226647552"
},
"data": null
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | Void |
备注
- [1] : APIRequest为动态查询请求对象，详情请移步全局请求格式
