按层级(下一层)查询位置信息(API名称:findPagedAddress)
功能介绍
按层级(下一层)查询位置信息。
相关接口
接口名称 |
调用说明 |
---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/address/findPagedAddress |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
parentId |
Long |
否 |
父节点ID。第一层级数据的parentId为-1。 |
address |
String |
否 |
行政区域名称。 |
addressCode |
String |
否 |
行政区域编码。 |
addressIds |
List<Long> |
否 |
位置ID集合(精确查询,集合数量最多200) |
addressCodes |
List<String> |
否 |
位置编码集合(精确查询,集合数量最多200) |
page.start |
int |
是 |
起始点,从0开始。 |
page.count |
int |
是 |
每页查询数量,最多支持200条。 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
status |
String |
处理结果。 |
msg |
String |
错误信息。 |
data |
Object |
返回结果。 |
data参数说明
参数 |
类型 |
描述 |
---|---|---|
pos |
Integer |
当前页数据起始下标 |
totalCount |
Integer |
总记录数 |
data |
Object |
当前页数据集合,具体字段说明见下 |
data.data参数
参数 |
类型 |
描述 |
---|---|---|
addressId |
Long |
位置ID |
addressCode |
String |
位置编码 |
address |
String |
位置名称 |
detailedAddress |
String |
位置详细地址 |
parentId |
Long |
父级位置ID |
addressPath |
String |
位置层级路径(父层) |
addressLevel |
Integer |
当前位置层级 |
description |
String |
描述 |
coordinateType |
String |
定位系统类型 |
longitude |
String |
经度 |
latitude |
String |
纬度 |
coordinate |
String |
坐标位置 |
udfExtend1 |
String |
扩展属性1 |
udfExtend2 |
String |
扩展属性2 |
udfExtend3 |
String |
扩展属性3 |
udfExtend4 |
String |
扩展属性4 |
udfExtend5 |
Date |
扩展属性5 |
udfExtend6 |
Date |
扩展属性6 |
udfExtend7 |
String |
扩展属性7 |
udfExtend8 |
String |
扩展属性8 |
udfExtend9 |
String |
扩展属性9 |
udfExtend10 |
String |
扩展属性10 |
hasSubNode |
boolean |
是否有子层级 |
请求示例
{ "parentId": null, "address": null, "addressCode": null, "addressIds": [], "addressCodes": [ "hzjTest1" ], "page": { "start": 0, "count": 20 } }
响应示例
{ "status": "success", "msg": null, "data": { "data": [ { "appName": "pub-server", "entityName": "Address", "lastUpdateDate": "2024-09-20T14:24:04.000+08:00", "lastUpdatedBy": 5005466, "creationDate": "2024-09-20T10:24:24.000+08:00", "createdBy": 5005466, "deleteFlag": 0, "tenantId": 5000034, "description": "描述一下", "parentId": 5026528, "addressPath": "5026256.5026275.5026528", "addressLevel": 4, "address": "hzjTest1", "addressCode": "hzjTest1", "addressId": 5913544, "longitude": "114.114449", "latitude": "22.604495", "coordinate": "", "coordinateType": "GPS", "detailedAddress": "深圳东站 ? 广东省深圳市龙岗区布吉街道吉华路94号", "udfExtend2": "udf2", "udfExtend3": "udf3", "udfExtend4": "udf4", "udfExtend5": "2024-09-20T00:00:00.000+08:00", "udfExtend6": "2024-09-21T00:00:00.000+08:00", "udfExtend1": "udf1", "udfExtend7": "udf7", "udfExtend8": "udf8", "udfExtend9": "udf9", "udfExtend10": "udf10", "geoHash": "ws10sep8", "hasSubNode": false } ], "pos": 0, "total_count": 1, "entityName": null, "totalCount": 1 }, "success": true, "failed": false }