设备分页列表
接口地址:/openapi/ai/devicePage?pageNo=1&pageSize=10
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"expire": "",
"installStatus": "",
"offlineEndDays": 0,
"offlineStartDays": 0,
"online": "",
"receiveStatus": "",
"serialNumbers": [],
"orgId":0,
"currentUserId":0,
"expireStartDate": null,
"expireEndDate": null,
"projectId": 0
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
orgId | 组织-公司 | false | integer(int64) | ||
expire | 到期情况:NORMAL,EXPIRE,ONE_TO_THREE_REMAIN,THREE_TO_THIRTY_REMAIN | false | string | ||
installStatus | 安装状态:INSTALL,UNINSTALL | false | string | ||
offlineEndDays | 离线天数(结束) | false | integer(int32) | ||
offlineStartDays | 离线天数(开始) | false | integer(int32) | ||
online | 在线状态:ON_LINE,OFF_LINE | false | string | ||
receiveStatus | 领用状态:RECEIVE,NO_RECEIVE | false | string | ||
serialNumbers | 序列号[‘序列号1’,’序列号2’,’….’] | false | array | ||
currentUserId | 当前领用人 | false | array | ||
expireStartDate | 到期开始日期(格式: yyyy-MM-dd) | false | string | ||
expireEndDate | 到期结束日期(格式: yyyy-MM-dd) | false | string | ||
projectId | 工地ID | false | integer(int64) | ||
pageNo | pageNo | query | false | integer(int32) | |
pageSize | pageSize | query | false | integer(int32) |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | R«open-platform 分页简单对象«AISupervisionDevicePageVo»» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
current | 当前页 | integer(int64) | |
records | 查询数据列表 | array | AISupervisionDevicePageVo |
activateDate | 激活日期 | string | |
deviceId | 设备ID | integer | |
deviceStatus | 设备状态 | string | |
deviceStatusDesc | 设备状态描述 | string | |
endDate | 到期日期 | string | |
installStatus | 安装状态 | string | |
installStatusDesc | 安装状态描述 | string | |
leftDay | 剩余天数 | integer | |
online | 在线状态 | boolean | |
onlineDesc | 在线状态描述 | string | |
orgId | 组织ID | integer | |
orgName | 组织 | string | |
projectId | 工地ID | integer | |
receiveStatus | 领用状态 | boolean | |
receiveStatusDesc | 领用状态描述 | string | |
receiveUserName | 领用人 | string | |
receiveUserId | 领用人Id | string | |
receiveUserMobile | 领用人手机号 | string | |
serialNumber | 序列号 | string | |
lastBindDate | 最近绑定时间 | string | |
lastHeartBeatTime | 最近心跳时间 | long | |
address | 最近地址 | string | |
lat | 纬度 | string | |
lon | 经度 | string | |
idleMinutes | 闲置时间(分钟) | integer(int64) | |
signalLevel | 信号强度(1,2,3,4) | integer | |
lastSnapshotUrl | 最后一张快照 | string | |
nearSnapshotUrlList | 最近快照 | array | |
size | 每页显示条数 | integer(int64) | |
total | 总数 | integer(int64) | |
message | string | ||
successful | boolean |
响应示例:
{
"code": 0,
"data": {
"current": 0,
"records": [
{
"activateDate": "",
"deviceId": 0,
"deviceStatus": "",
"deviceStatusDesc": "",
"endDate": "",
"installStatus": "",
"installStatusDesc": "",
"leftDay": 0,
"online": false,
"onlineDesc": "",
"orgId": 0,
"orgName": "",
"projectId": 0,
"receiveStatus": false,
"receiveStatusDesc": "",
"receiveUserName": "",
"receiveUserId":"",
"receiveUserMobile":"",
"serialNumber": "",
"lastBindDate":"",
"lastHeartBeatTime":123,
"lat":"xx",
"lon":"xx",
"address":"xxxx",
"idleMinutes": 0,
"signalLevel": 0,
"lastSnapshotUrl":"http:xxxxx",
"nearSnapshotUrlList":["a","b","c"]
}
],
"size": 0,
"total": 0
},
"message": "",
"successful": true
}
单设备基本信息
接口地址:/openapi/ai/getDeviceInfo
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
请求参数:
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
serialNumber | serialNumber | query | false | string | |
deviceId | deviceId | query | false | integer(int64) |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | R«DevicePfInfo» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | DevicePfInfo | DevicePfInfo | |
deviceType | 设备类型 | string | |
id | 设备ID | integer(int64) | |
lastHeartBeatTime | 上次心跳时间 | integer(int64) | |
lastSnapshot | 最新快照 | string | |
name | 摄像机名称 | string | |
nearSnapshots | 最新快照列表 | string | |
offlineStartTime | 设备离线开始时间 | string(date-time) | |
online | 是否在线,true(在线),false(离线) | boolean | |
serialNumber | 摄像机序列号 | string | |
signalLevel | 信号强度(3:优 2:良 1:差) | integer(int32) | |
status | string | ||
message | string | ||
successful | boolean |
响应示例:
{
"code": 0,
"data": {
"deviceType": "",
"id": 0,
"lastHeartBeatTime": 0,
"lastSnapshot": "",
"name": "",
"nearSnapshots": "",
"offlineStartTime": "",
"online": false,
"serialNumber": "",
"signalLevel": 0,
"status": ""
},
"message": "",
"successful": true
}
检查设备是否在线
接口地址:/openapi/ai/checkIsOnline/{serialNumber}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
serialNumber | serialNumber | path | true | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | R«boolean» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | boolean | ||
message | string | ||
successful | boolean |
响应示例:
{
"code": 0,
"data": true,
"message": "",
"successful": true
}
设备操作记录
接口地址:/openapi/ai/searchCmdByStartId?startId=0&pageSize=100
备注:startId首次请求请传0,以后每次请传数据最后一条的id
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"cmdType": "start_streaming",
"startTime": 1668060250,
"endTime": 1668062897
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
serialNumber | 设备序列号 | false | string | ||
startTime | 开始时间(秒) | true | Integer | ||
endTime | 结束时间(秒) | true | Integer | ||
startId | 起始id) | true | Integer | ||
pageSize | 每页条数 | false | Integer |
正常响应示例:
{
"code": 200,
"message": "成功",
"data": [
{
"cmdType": "",
"cmdTypeDesc": "",
"createdByName": "",
"createdTime": 0,
"createdTimeStr": "",
"deviceId": 0,
"id": 0,
"msgId": "",
"projectContractNo": "",
"projectId": 0,
"projectName": "",
"serialNumber": ""
}
],
"successful": true
}
查询设备在线时长
接口地址:/openapi/ai/getDeviceOnlineTimePage
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
请求参数:
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
page | page | query | true | integer(int32) | |
pageSize | pageSize | query | true | integer(int32) | |
dateOfDay | dateOfDay(数字,如:20230222) | query | true | integer(int32) | |
orgId | orgId | query | false | integer(int64) |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | R«open-platform 分页简单对象«OnlineRecord»» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | open-platform 分页简单对象«OnlineRecord» | ||
current | 当前页 | integer(int64) | |
records | 查询数据列表 | array | OnlineRecord |
buildStatus | 工地绑定状态 | string | |
dateOfDay | 所属日期 | integer | |
deviceId | 设备id | long | |
lastUpdateTime | 上次更新时间毫秒 | long | |
onlineTime | 在线分钟数 | integer | |
orgId | 所属公司id | long | |
orgName | 所属公司名称 | string | |
projectId | 所属项目id | long | |
serialNumber | 摄像机序列号 | string | |
workOnlineTime | 工作时间在线分钟数 | integer | |
size | 每页显示条数 | integer(int64) | |
total | 总数 | integer(int64) | |
message | string | ||
successful | boolean |
响应示例:
{
"code": 0,
"data": {
"current": 0,
"records": [
{
"buildStatus": "",
"dateOfDay": 0,
"deviceId": 0,
"lastUpdateTime": 0,
"onlineTime": 0,
"orgId": 0,
"orgName": "",
"projectId": 0,
"serialNumber": "",
"workOnlineTime": 0
}
],
"size": 0,
"total": 0
},
"message": "",
"successful": true
}
查询设备心跳记录
接口地址:/openapi/ai/searchDeviceHeartBeatByStartId
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
{
"endTimeSec": 0,
"startTimeSec": 0,
"serialNumbers": []
}
请求参数:
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
startId | startId | query | true | integer(int64) | |
pageSize | pageSize | query | false | integer(int32) | |
deviceEventParam | DeviceEventParam | body | true | DeviceEventParam | DeviceEventParam |
endTimeSec | 结束时间秒 | false | integer(int64) | ||
serialNumbers | 序列号 | false | array | string | |
startTimeSec | 开始时间秒 | false | integer(int64) |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | R«List«DeviceEventSimpleVo»» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | array | DeviceEventSimpleVo | |
createdTimeLong | 创建时间秒 | integer(int64) | |
createdTimeStr | 时间 | string | |
deviceId | 设备ID | integer(int64) | |
eventType | 事件类型 | string | |
id | integer(int64) | ||
serialNumber | 设备序列号 | string | |
occurredTimeLong | 发生时间(秒) | integer(int64) | |
occurredTime | 发生时间(字符串) | string | |
message | string | ||
successful | boolean |
响应示例:
{
"code": 0,
"data": [
{
"createdTimeLong": 1710205200,
"createdTimeStr": "2024-03-12 09:00:00",
"deviceId": 0,
"eventType": "",
"id": 0,
"serialNumber": "",
"occurredTimeLong": "1710205200",
"occurredTime": "2024-03-12 09:00:00"
}
],
"message": "",
"successful": true
}
设备结束时间变更(第三方提供)
接口地址:https://xxx.com/deviceEndTimeUpdate
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:
请求示例:
[
{
"endDate": "2022-07-23",//到期时间
"predictedEndDate":"2022-07-23",//预计到期时间
"renewDate": "2022-07-22"//续费时间
"sn": "SC81800636xx"//设备sn
}
]
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
endDate | 到期时间 | false | string | ||
predictedEndDate | 预计到期时间 | false | string | ||
renewDate | 续费时间 | false | string | ||
sn | 设备sn | false | string |
正常响应示例:
{
"code":200,
"message":"成功"
}
最后编辑:admin 更新时间:2025-05-30 16:03