文档首页/ ISDP/ API参考/ API接口/ 基础数据管理/ 根据位置名称查询位置信息（含层级）（API名称：findPagedAddressByName）
更新时间：2024-01-18 GMT+08:00
查看PDF
分享

根据位置名称查询位置信息（含层级）（API名称：findPagedAddressByName）

功能介绍

根据位置名称查询位置信息(含层级)。

相关接口

接口名称

调用说明

获取Token

调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。

URL

请求方式

HTTPS地址

服务架构

消息体类型

POST

https://isdp+域名/openapi/v1/address/findPagedAddressByName

OpenAPI

application/json

请求头

KEY

VALUE

是否必填

描述

Content-Type

application/json

是

无

Authorization

bearer ${access_token}

是

bearer +“ ”+5.2.1中获取的access_token的值

请求参数

参数

类型

是否必填

描述

page.start

integer

是

分页起始位置。

page.count

integer

是

每页查询数量。不超过200个。

address

String

是

位置名称。

响应参数

参数

类型

描述

status

String

操作状态（success/failed）。

msg

String

错误信息。

data

Object

返回分页数据信息。

data.totalCount

Integer

数据总数。

data.pos

integer

分页开始位置。

data.data

Object

位置信息列表。

data.data.addressId

Long

位置ID。

data.data.addressCode

String

位置编码。

data.data.address

String

位置名称。

data.data.addressLevel

Integer

位置层级。

data.data.addressPath

String

位置路径。

data.data.parentId

Long

上级位置ID。

data.data.longitude

Double

经度。

data.data.latitude

Double

纬度。

data.data.coordinate

String

位置坐标。

data.data.coordinateType

String

位置类型。

data.data.hasSubNode

boolean

是否有下级位置信息。

请求示例

{
       "page":{
              "start":0,
              "count":10
       },
       "address":"XX"
}

响应示例

{
  "status": "success",
  "msg": null,
  "data": {
    "data": [
      {
        "appName": "pub-server",
        "entityName": "address",
        "lastUpdateDate": "2022-04-06T08:14:54.000+00:00",
        "lastUpdatedBy": 111462,
        "creationDate": "2021-03-19T03:07:00.000+00:00",
        "createdBy": -88,
        "deleteFlag": 0,
        "tenantId": 100045,
        "description": null,
        "parentId": -1,
        "addressPath": null,
        "addressLevel": 1,
        "address": "中国",
        "addressCode": "CN",
        "addressId": 1013440,
        "longitude": null,
        "latitude": null,
        "coordinate": null,
        "coordinateType": null,
        "children": [
          {
            "appName": "pub-server",
            "entityName": "address",
            "lastUpdateDate": "2022-04-06T08:14:56.000+00:00",
            "lastUpdatedBy": 111462,
            "creationDate": "2021-03-19T03:07:01.000+00:00",
            "createdBy": -88,
            "deleteFlag": 0,
            "tenantId": 100045,
            "description": null,
            "parentId": 1013440,
            "addressPath": "1013440",
            "addressLevel": 2,
            "address": "XX省",
            "addressCode": "430000",
            "addressId": 1013458,
            "longitude": null,
            "latitude": null,
            "coordinate": null,
            "coordinateType": null
          }
        ]
      }
    ],
    "pos": 0,
    "totalCount": 1,
    "entityName": "address"
  }
}
父主题： 基础数据管理

相关文档