文档首页/ ISDP/ API参考/ API接口/ 基础数据管理/ 查询行政区域（API名称：findPagedAddress）
更新时间：2024-07-22 GMT+08:00
查看PDF
分享

查询行政区域（API名称：findPagedAddress）

功能介绍

查询行政区域。

相关接口

接口名称

调用说明

获取Token

调用该接口获取到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

否

行政区域编码。

page.start

int

是

起始点，从0开始。

page.count

int

是

每页查询数量，最多支持200条。

响应参数

参数

类型

描述

status

String

处理结果。

msg

String

错误信息。

data

Object

返回结果。

data参数说明

参数

类型

描述

total_count

Long

总计数

entityName

String

实体名称。

totalCount

Long

总计数

data.data参数

参数

类型

描述

appName

String

应用名称。

entityName

String

实体名称。

lastUpdateDate

datetime

最后更新时间

lastUpdatedBy

Long

最后修改人ID

creationDate

datetime

最后更新时间

createdBy

Long

创建人ID

deleteFlag

Integer

是否删除0-正常1-已删除

tenantId

Long

位置ID。

description

String

描述

parentId

Long

上级位置ID。

addressPath

String

位置路径。

addressLevel

Integer

位置层级。

address

String

位置名称。

addressCode

String

位置编码。

addressId

Long

位置ID。

longitude

Double

经度。

latitude

Double

纬度。

coordinate

String

位置坐标。

coordinateType

String

位置类型。

detailedAddress

String

详细地址

udfExtend2

String

扩展属性2。

udfExtend3

String

扩展属性3。

udfExtend4

String

扩展属性4。

udfExtend1

String

扩展属性1。

udfExtend7

String

扩展属性7。

udfExtend8

String

扩展属性8。

udfExtend9

String

扩展属性9。

udfExtend10

String

扩展属性10。

geoHash

String

经纬度对应geoHash

hasSubNode

boolean

是否有下级位置信息。

请求示例

{
  "parentId":-1,
  "address":"",
  "addressCode":"",
  "page":{
    "start":0,
    "count":1
  }
}

响应示例

{
    "status": "success",
    "msg": null,
    "data": {
        "data": [
            {
                "appName": "pub-server",
                "entityName": "Address",
                "lastUpdateDate": "2023-12-11T23:57:35.000+08:00",
                "lastUpdatedBy": -1,
                "creationDate": "2023-10-19T17:14:06.000+08:00",
                "createdBy": -1,
                "deleteFlag": 0,
                "tenantId": 1,
                "description": null,
                "parentId": 1033231,
                "addressPath": "69585.1032231.1033231",
                "addressLevel": 4,
                "address": "xxx",
                "addressCode": "xxx",
                "addressId": 5783601,
                "longitude": null,
                "latitude": null,
                "coordinate": null,
                "coordinateType": null,
                "detailedAddress": null,
                "udfExtend2": null,
                "udfExtend3": null,
                "udfExtend4": null,
                "udfExtend1": null,
                "udfExtend7": null,
                "udfExtend8": null,
                "udfExtend9": null,
                "udfExtend10": null,
                "geoHash": null,
                "hasSubNode": false
            }
        ],
        "pos": 0,
        "total_count": 15879,
        "entityName": null,
        "totalCount": 15879
    },
    "failed": false,
    "success": true
}
父主题： 基础数据管理

相关文档