1. 视频AI预警信息
获取视频AI预警信息
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/device/monitor/ai/warn |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
projectId | 是 | 项目ID |
deviceCode | 否 | 监测点位设备号,不填写则默认为查询所有 |
startTime | 是 | 查询开始时间,格式为:yyyy-mm-dd hh:mm:ss(查询间隔时间不能大于一天) |
endTime | 是 | 查询结束时间,格式为:yyyy-mm-dd hh:mm:ss(查询时间不能大于一天) |
pageNum | 是 | 页码,整数,从1开始 |
pageSize | 是 | 分页数据量,取值为1到100之间的整数 |
参数请求示例:
http://api.example.com/xxx?key=value
1.3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 响应码 |
message | string | 是 | 响应消息 |
data | object | 是 | 响应数据 |
pages | number | 是 | 总页数 |
hasNext | boolean | 是 | 是否有下一页 |
total | number | 是 | 总条数 |
list | array | 是 | 数据 |
projectName | string | 是 | 项目名称 |
deviceCode | string | 是 | 监测设备code |
deviceName | string | 是 | 监测设备名称 |
alarmType | number | 是 | 预警类型1:人员入侵,2:安全帽预警 |
recordTime | string | 是 | 预警时间: 格式为:yyyy-mm-dd hh:mm:ss |
alarmStatus | string | 是 | 预警事件的当前状态:1:暂未处理;2:处理完成 |
alarmPhotoUrl | string | 是 | 预警图片文件url |
warnRecordId | string | 是 | 预警记录唯一标识id |
handleTime | string | 是 | 处理时间: 格式为:yyyy-mm-dd hh:mm:ss |
响应数据结构如下所示:
{
"code": 0,
"message": null,
"data": {
"pages": 1,
"hasNext": false,
"total": 2,
"list":[
{
"projectName":"测试项目1",
"deviceCode":"TEST",
"deviceName":"监测设备",
"alarmType":1,
"recordTime":"2020-02-02 00:00:00",
"alarmStatus":"1",
"alarmPhotoUrl":"http://xxxx.xxx.xxx",
"warnRecordId":"xxxxxxxxxxxx",
"handleTime":"2020-02-02 00:00:00"
}
]
}
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。