1. 获取AI预警列表(项目)
根据条件获取指定项目下的AI预警信息
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/ai/alarm/project/alarmList |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
projectId | 是 | 项目ID |
analyzeCode | 否 | 预警类型编码 |
startTime | 是 | 开始时间(时间戳) |
endTime | 是 | 结束时间(时间戳) |
pageNum | 是 | 页码,整数,从1开始 |
pageSize | 是 | 分页数据量,取值为1到100之间的整数 |
参数请求示例:
http://api.example.com/xxx?key=value
1.3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 响应码 |
message | string | 是 | 响应消息 |
data | object | 是 | 响应数据 |
hasNext | object | 是 | 响应数据 |
pages | number | 是 | 页数 |
total | number | 是 | 总数 |
list | array | 是 | 数据list |
name | string | 是 | 预警区域(摄像头名字) |
deviceId | string | 是 | 设备ID |
alarmId | string | 是 | 预警信息ID |
analyzeType | string | 是 | 预警类型 |
alarmTime | string | 是 | 预警时间 |
state | number | 是 | 状态:1.未处理;2.处理中;3.处理完成;4.已审核 |
materialType | number | 否 | 素材类型(1.图片;2.视频) |
materialUrl | string | 否 | 素材地址 |
handleResult | string | 否 | 处理情况 |
响应数据结构如下所示:
{
"code" : 1,
"message" : "XXX",
"data" : [
"hasNext": false,
"pages": 1,
"total": 1,
"list": [
{
"name": "5#alarm",
"deviceId": "DAJDASKJDASKJDAK2121",
"alarmId": "XXXXXXXXXXXXXXX",
"analyzeType": "安全帽",
"alarmTime": "2023/02/03 12:22:22",
"state": 1,
"materialType": 1,
"materialUrl": "www.xxxx.xxxx",
"handleResult": "XXXXXXXXXXXXXXXXX"
}
]
]
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。