5.1 视频巡更报告API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
5.1.1 | 巡更报告分页 | /v1/iot/patrol/report/page | 1.0 |
5.1.2 | 巡更报告详情 | /v1/iot/patrol/repoDetail/detail | 1.0 |
API调用
5.1.1 巡更报告分页列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/report/page
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
type | body | Int | y | 巡更类型【区分视频巡更和图片巡更的报告类型,这里取值(0)】 |
isCreate | body | Int | y | 取值1 |
pageNo | body | Int | n | 当前页码 (默认起始值:1) |
pageSize | body | Int | n | 每页条数 (默认取值:10) |
projectId | 顶层 | Int | n | 项目ID |
taskDate | 顶部 | String | n | 时间段搜索,在"$gte"填写开始日期,在"$lte"填写截止日期 |
username | 顶层 | String | n | 巡更人名称---模糊搜索 |
taskName | 顶层 | String | n | 任务名称---模糊搜索 |
status | 顶层 | Int | n | 任务状态【未开始0,未完成2,已完成1】 |
请求Body描述(非Form表单数据)
{
"pageNo": 1,
"pageSize": 10,
"query": {
"type": {
"$eq": 0
},
"isCreate":{
"$eq": 1
},
"status": {
"$eq": 0
},
"projectId": {
"eq": 2360
}
"taskDate": {
"$gte": "2020-12-09",
"$lte": "2020-12-15"
},
"username": {
"$like": "赵xx"
},
"taskName": {
"$like": "报告xx"
}
},
"order": {
"createTime": "desc"
}
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述as |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
message | 顶层 | STRING | y | 响应消息文本 |
data | 顶层 | JSONObject | y | 响应数据对象 |
count | data | Int | y | 总条数 |
list | data | Array | y | 列表 |
id | list | String | y | 报告ID |
taskDate | list | String | n | 巡更日期 |
name | list | STRING | y | 视频巡更报告名称 |
taskName | list | STRING | y | 视频巡更任务名称 |
status | list | STRING | y | 任务状态 |
username | list | STRING | y | 巡更人名称 |
devCount | list | Int | y | 巡更设备数目 |
abnormalCount | list | Int | y | 检查异常数 |
{
"code": "200",
"message": "success",
"data": {
"count": 10,
"list": [
{
"id": "",
"taskDate": "2020-02-02",
"name": "",
"taskName": "",
"status": 1,
"username": "xxx(组)",
"devCount": 7,
"abnormalCount": 10,
}
]
}
}
5.1.2: 巡更报告详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/iot/patrol/repoDetail/detail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
type | body | Int | y | 巡更类型【区分视频巡更和图片巡更的报告类型,这里取值(0)】 |
taskId | body | STRING | y | 任务ID |
请求Body描述(非Form表单数据)
{
"type": 0,
"taskId": ""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 描述 |
---|---|---|---|
code | 顶层 | String | 响应码标识 |
message | 顶层 | String | 响应消息文本 |
data | 顶层 | JSONObject | 响应数据对象 |
taskDate | data | String | 日期 |
submitTime | data | String | 提交巡更时间 |
username | data | String | 巡更人 |
abnormalCount | data | Int | 异常检查项 |
status | data | Int | 任务状态【未开始0,未完成2,已完成1】 |
patrolSituation | data | Array | 巡更情况列表 |
fetchImgUri | patrolSituation | String | 抓图图片地址Uri |
devName | patrolSituation | String | 视频设备名称 |
devLocation | patrolSituation | String | 设备位置 |
startPatrolTime | patrolSituation | String | 开始巡更时间 |
duration | patrolSituation | Int | 巡更时长(秒) |
results | patrolSituation | Array | 巡更结果 |
result | results | JSONObject | 检查项巡更结果 |
comment | result | String | 检查项的结果备注 |
situation | result | Int | 检查项正常1,异常0 |
id | results | String | 检查项ID |
content | results | String | 检查项内容描述 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"taskDate": "2020-05-07",
"submitTime": "2020-05-07 14:23",
"username": "",
"abnormalCount": 0,
"status": 1,
"patrolSituation": [{
"devName": "",
"devLocation": "",
"startPatrolTime": "13:50:58",
"duration": 5,
"results" : [
{
"result" : {
"comment" : "有垃圾",
"situation" : 0
},
"id" : "5fce4d6d78b3f54bb8412f26",
"content" : "检查项21"
}
]
}]
}
}
5.3: 修改巡更报告
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/report/update
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | y | 主键id |
date | data | date | y | 日期 |
submitTime | data | date | y | 提交巡更时间 |
patrolPeople | data | string | n | 巡更人 |
abnormalNumber | data | int | n | 异常检查项 |
completionStatus | data | string | n | 完成情况 |
请求Body描述(非Form表单数据)
{
"id": 1,
"date": 2020-01-31,
"submitTime": 2020-02-01 01:00,
"patrolPeople": "",
"abnormalNumber": 0,
"completionStatus": ""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
5.4: 删除巡更报告
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/report/remove
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | y | 主键id |
请求Body描述(非Form表单数据)
{
"id": 1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
amount | data | int | 是 | 成功条数 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
amount: 0
}
}