设备群组查询(API名称:queryGroupsByProject)
功能介绍
用于与客户系统对接根据项目查询项目下群组。
相关接口
接口名称 | 调用说明 |
|---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 | HTTPS地址 | 服务架构 | 消息体类型 |
|---|---|---|---|
POST | https://isdp+域名/openapi/v1/helmet/queryGroupsByProject | OpenAPI | application/json |
请求头
KEY | VALUE | 是否必填 | 描述 |
|---|---|---|---|
Content-Type | application/json | 是 | 无 |
Authorization | bearer ${access_token} | 是 | bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
page | Object | 否 | 分页参数 |
start | Integer | 否 | 当前页码 分页参数,page子项 |
count | Integer | 否 | 每页条数 分页参数,page子项 |
deviceId | String | 否 | 设备编码 |
isdpDeviceId | String | 否 | 设备唯一键 多个通过英文逗号分隔,最多200个 |
deviceName | String | 否 | 设备名称 |
coordType | String | 否 | 坐标系类型 可选值WGS84或GCJ02或BD09,不填默认WGS84 |
projectName | String | 否 | 项目名称 |
projectNumber | String | 否 | 项目编码 |
groupId | Long | 否 | 群组Id |
groupName | String | 否 | 群组名称 |
deviceUserId | Long | 否 | 设备使用Id |
deviceUserName | String | 否 | 设备使用人名称 |
ownnerName | String | 否 | 设备责任人名称 |
deviceState | String | 否 | 设备状态 可选值ONLINE/OFFLINE/UNALLOCATED/MEETING/MULTI_MEETING 多个以英文逗号分隔,不传默认查询所有 |
orgId | Long | 否 | 组织Id |
响应参数
参数 | 类型 | 描述 |
|---|---|---|
status | Int | 响应状态,1标识成功,否则不成功 |
message | String | 响应信息,SUCCESS标识成功,否则失败 |
error | String | 错误信息,接口错误时有值,正常调用时为空 |
data | object | 响应消息体 |
groupId | Long | 群组Id,data子项 |
groupName | String | 群组名称,data子项 |
timestamp | Date | 响应时间 |
请求示例
{
"projectNumber" : "1126项目编码",
"projectName" : "1126项目名称"
} 响应示例
{
"status" : 1,
"message" : "SUCCESS",
"error" : null,
"data" : [{
"groupId" : 113117,
"groupName" : "Test群组"
}, {
"groupId" : 100000,
"groupName" : "默认群组"
}
],
"timestamp" : "2022-09-06T17:39:33.270+0800"
} 状态码
状态码请参见状态码。
错误码
错误码请参见错误码。

