文档首页/ ISDP/ API参考/ API接口/ 智能安监/ 设备管理/ 设备信息列表查询(API名称:queryAll)
更新时间:2024-01-18 GMT+08:00
分享

设备信息列表查询(API名称:queryAll)

功能介绍

用于与客户系统对接查询设备列表。

相关接口

接口名称

调用说明

获取Token

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

URL

请求方式

HTTPS地址

服务架构

消息体类型

POST

https://isdp+域名/openapi/v1/helmet/queryAll

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

设备责任人名称

deviceType

String

设备类型

可选值WEBCAM/MONITOR_BALL/BODY_WORN_CAMERA/INTELLIGENT_SAFETY_HELMET/INTELLIGENT_MINER_L

IGHT/MOBILE/IVS1800/IVS3800

多个以英文逗号分隔,不传默认查询所有

deviceState

String

设备状态

可选值ONLINE/OFFLINE/UNALLOCATED/MEETING/MULTI_MEETING

多个以英文逗号分隔,不传默认查询所有

orgId

Long

组织Id

响应参数

参数

类型

描述

isdpDeviceId

String

isdp唯一设备ID

deviceId

String

设备ID

channelId

String

通道ID

deviceName

String

设备名称

deviceState

String

设备状态

accessProtocol

String

接入协议

deviceType

String

设备类型

deviceSystemState

String

设备管理状态

description

String

描述

model

String

设备型号

manufacture

String

生产厂商

channelTotal

int

通道总数

streamTotal

int

每个通道码流数量

firmware

String

摄像头固件版本号

deviceAbility

String

能力集

mac

String

mac地址

createTime

String

创建时间

updateTime

String

更新时间

protocolVersion

String

协议版本

deviceIp

String

设备ip

devicePort

String

设备端口

projectName

String

项目名称

projectNumber

String

项目编码

deviceAddress

String

设备地址

fileId

String

图片编号

sysType

String

系统类型

fileSize

String

文件大小

fileName

String

文件名称

fileExt

String

文件扩展名

deviceAddressNumber

String

设备地址编号

deviceSubType

String

子设备类型

deviceAlarmStatus

String

设备告警状态

autoJoin

String

是否主动入会

battery

String

电量

ownnerId

String

设备责任人ID

longitude

String

经度

latitude

String

纬度

chatJid

String

IM群组ID

chatId

String

IM聊天ID

liveChannelId

String

频道播放ID

userName

String

设备使用人名称

ownnerName

String

设备责任人名称

webPlayUrl

String

web播放地址

bindStatus

Integer

设备绑定状态

bindUserId

Long

设备绑定的用户Id

buOrgId

Long

设备所在组织Id

buOrgName

String

设备所在组织名称

coordType

String

坐标类型

creationDate

Date

创建时间

deviceManageState

String

设备管理状态

deviceStateBefore

String

设备上报之前的状态

deviceTypeName

String

设备类型名称

deviceUserId

Long

设备使用人Id

deviceUserName

String

设备使用人名称

deviceUserNameOnly

String

设备使用人名称

enableEndSide

String

是否开启边缘AI

enableVideoRecording

String

是否开启录像

groupId

Long

群组Id

groupName

String

群组名称

integrationPlatform

String

集成平台

lastReportTime

Date

最后一次上报时间

lastUpdateDate

Date

最后更新时间 (时间戳)

lastUpdatedBy

Long

最后更新人(时间戳)

onlineDuration

Long

设备在线时长

stateChangeReason

String

设备状态改变原因

stateChangeReasonCode

String

设备状态改变原因码

storageRemain

Long

存储保留

storageTotal

Long

存储总计

tenantId

Long

租户Id

请求示例

{
"deviceId" : "",
        "deviceName" : "",
        "deviceType" : "",
        "projectNumber" : "",
        "projectName" : "",
        "deviceState" : "ONLINE,MEETING",
        "page" : {
                 "count" : 500,
                 "start" : 0
        },
        "coordType" : "BD09"
}

响应示例

{
"status" : 1,
         "message" : "SUCCESS",
         "error" : null,
         "data" : {
                   "data" : [{
                                     "deviceId" : "05238798080487120101",
                                     "isdpDeviceId" : "05238798080487120101",
                                     "channelId" : "-1",
                                     "deviceName" : "HoloSensSDC",
                                     "deviceState" : "MEETING",
                                     "accessProtocol" : null,
                                     "projectNumber" : "defaultProject",
                                     "projectName" : "默认项目",
                                     "deviceType" : "WEBCAM",
                                     "deviceSystemState" : null,
                                     "description" : null,
                                     "model" : null,
                                     "manufacture" : "HUAWEI",
                                     "channelTotal" : 0,
                                     "streamTotal" : 0,
                                     "firmware" : null,
                                     "deviceAbility" : null,
                                     "mac" : null,
                                     "createTime" : null,
                                      "updateTime" : null,
                                     "protocolVersion" : null,
                                     "deviceIp" : null,
                                     "devicePort" : null,
                                     "tenantId" : 886,
                                     "deviceAddress" : null,
                                     "fileId" : null,
                                     "sysType" : null,
                                     "fileSize" : null,
                                     "fileName" : null,
                                     "fileExt" : null,
                                     "deviceAddressNumber" : null,
                                     "webPlayUrl" : null,
                                     "deviceManageState" : "ACTIVATION",
                                     "deviceSubType" : "IPC",
                                     "creationDate" : 1661848660000,
                                     "lastUpdateDate" : 1661848660000,
                                     "lastUpdatedBy" : 1,
                                     "deviceAlarmStatus" : null,
                                     "autoJoin" : null,
                                     "battery" : null,
                                     "ownnerId" : null,
                                     "longitude" : null,
                                     "latitude" : null,
                                     "buOrgId" : 1409142,
                                     "buOrgName" : "广东省",
                                     "coordType" : null,
                                     "chatJid" : null,
                                     "chatId" : null,
                                     "liveChannelId" : "320042737078341",
                                     "deviceUserId" : null,
                                     "groupId" : null,
                                     "groupName" : null,
                                     "bindStatus" : null,
                                     "bindUserId" : null,
                                     "storageTotal" : null,
                                     "storageRemain" : null,
                                     "onlineDuration" : null,
                                     "enableEndSide" : null,
                                     "enableVideoRecording" : null,
                                     "lastReportTime" : null,
                                     "integrationPlatform" : "IVS3800",
                                     "stateChangeReason" : null,
                                     "stateChangeReasonCode" : null,
                                     "deviceStateBefore" : null,
                                     "userName" : null,
                                     "ownnerName" : null,
                                     "deviceUserName" : null,
                                     "deviceUserNameOnly" : null,
                                     "deviceTypeName" : "摄像头"
                            }
                   ],
                   "pos" : 0,
                   "total_count" : 1,
                   "entityName" : null,
                   "totalCount" : 1
         },
         "timestamp" : "2022-09-06T16:55:34.097+0800"
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

相关文档