4.1 视频巡更任务API

API列表

编号 API名称 路径 版本
4.1.1 巡更任务分页 /v1/iot/patrol/task/page 1.0
4.1.2 开始巡更任务 /v1/iot/patrol/task/beginTask 1.0
4.1.3 提交巡更任务结果 /v1/iot/patrol/task/commitTask 1.0
4.1.4 个人每天任务列表 /v1/iot/patrol/task/empTaskList 1.0
4.1.5 个人每天任务完成率 /v1/iot/patrol/task/empTaskCP 1.0
4.1.6 获取视频设备巡更进展详情 /v1/iot/patrol/task/devPatrolSituation 1.0

API调用

4.1.1: 巡更任务分页列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/page

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（0）】
pageNo body Int n 当前页码 (默认取值：1)
pageSize body Int n 每页条数 (默认取值：10)
projectId 顶层 Int n 项目ID
taskDate 顶部 String n 时间段搜索，在"$gte"填写开始日期，在"$lte"填写截止日期
username 顶部 String n 巡更人名称---模糊搜索
name 顶部 String n 任务名称---模糊搜索

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "query": {
        "type": {
                "$eq": 0
        },
        "projectId": {
                "$eq": 610
        }
        "taskDate": {
                "$gte": "2020-12-09",
                "$lte": "2020-12-15"
        },
        "username": {
                "$like": "赵xx"
        },
        "name": {
                "$like": "任务xx"
        }
    },
    "order": {
        "createTime": "desc"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
count data int y 总条数
list data Array y 任务列表
taskTime list String y 任务时间点
name list STRING y 任务名称
username list STRING n 巡更人名称
deviceCount list int y 巡更设备数
cycleType list STRING y 任务周期: day、week、month
patrolTime list String y 巡更时间段【08:00-10:00】
startDate list String y 巡更计划开始时间
endDate list String y 巡更计划结束时间
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "count": 10,
      "list": [
          {
            "taskTime": "2020-02-02 12:12:12",
            "name": "",
            "userName": "",
            "deviceCount": 7,
            "cycleTyepe": "week",
            "patrolTime": "08:00-10:00",
            "startDate": "2020-02-12", 
            "endDate": "2020-02-13" 
        }
      ]
  }
}

4.2: 新增巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/add

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（0）】
taskDate body Date n 任务日期
name body String n 视频巡更任务名称
username body String n 巡更人
devCount body Int n 巡更设备数
status body Int y 任务状态：【未完成(0)、已完成(1)】
cycleType body String n 任务周期【每天(week)、每周(week)、每月(month)】
patrolTimes body Array y 巡更时间("08:00"、"10:00")
startDate body Date n 计划开始时间
endDate body Date n 计划结束时间

请求Body描述(非Form表单数据)

{
    "type": 1,
    "taskDate": "2020-01-01",
    "name": "视频任务01",
    "username": "张三",
    "devCount": 7,
    "status": 0,
       "cycleType": "day",
    "patrolTimes": ["08:00","10:00"],
    "startDate": "2020-01-01",
    "endDate": "2020-01-03"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 String y 响应码标识
message 顶层 String y 响应消息文本
data 顶层 JSONObject y 响应数据对象
id data String y 任务主键ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
          "id": ""
  }
}

4.3: 巡更任务详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 主键id

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
taskdate data date n 任务日期
taskname data string n 任务名称
watchman data string n 巡更人
equipmentNumber data int n 巡更设备数
taskcycle data string n 任务周期
patroltime data string n 巡更时间
planstarttime data date n 计划开始时间
planendtime data date n 计划结束时间
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "taskdate": 2020-02-01,
    "taskname": "",
    "watchman": "",
    "equipmentNumber": "",
    "taskcycle": "",
    "patroltime": "",
    "planstarttime": 2020-02-12,
    "planendtime": 2020-12-12
  }
}

4.4: 修改巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/update

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 主键id
taskdate body date n 任务日期
taskname body string n 任务名称
watchman body string n 巡更人
equipmentNumber body int n 巡更设备数
taskcycle body string n 任务周期
patroltime body string n 巡更时间
planstarttime body date n 计划开始时间
planendtime body date n 计划结束时间

请求Body描述(非Form表单数据)

{
    "id": 1,
    "taskdate": 2020-02-01,
    "taskname": "",
    "watchman": "",
    "equipmentNumber": "",
    "taskcycle": "",
    "patroltime": "",
    "planstarttime": 2020-02-12,
    "planendtime": 2020-12-12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.5: 删除巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/remove

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 主键id

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.1.2: 开始巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/beginTask

方法：POST

请求参数

名称 位置 类型 必填 描述
id body String y 任务ID
type body int y 计划类型，视频取值0

请求Body描述(非Form表单数据)

{
    "id": "5fd0c672f0934871e5215fd9",
    "type": 0
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
status 顶层 Int 任务状态：【未开始0，已完成1，未完成2】
order devices Int 巡更顺序
devId devices String 视频设备ID
devName devices String 摄像头名称
devTemplate devices String 设备模板
macAddress devices String MAC地址
spaceName devices String 设备位置
videoDuration devices Int 视频查看时长(秒)
patrolTime devices String 巡更时间(eg: 23：00)
checkItemCount devices Int 关联检查项数
checkItems devices Array 检查项数组
id checkItems String 检查项Id
content checkItems String 检查项内容描述
result checkItems JsonObject 检查项巡更结果
situation result Int 异常0，正常1
comment result String 检查项巡更结果备注
isExpired result boolean 是否过期：取true
返回结果示例
{    
    "code": "200",
    "message": "success",
    /*任务未完成*/
      "data": {
                  "taskId": "",
                "devices":[
                {
                  "order": 1,
                  "devId": "",
                  "devName": "摄像头01",
                  "devTemplate": "xxx(组)",
                  "macAddress": "20-50-63-20",
                  "spaceName": "",
                  "taskDate": "2021-01-13",
                  "videoDuration": 15,
                  "checkItemCount": 2,
                  "name": "每天9点巡更任务_任务",
                  "patrolTime": "23:00",
                  "taskTime": "2021-01-13 23:00:00",
                  "status": 2,
                  "checkItems": [
                    {
                        "id":"",
                        "content": "有无车辆",
                         "result": {
                            "comment": null,
                            "situation": 1
                        }
                    },{
                        "id": "",
                        "content": "有没垃圾",
                        "result": {
                            "comment": null,
                            "situation": 1
                        }
                    }
                  ]
                }
            ]
          }
   /*任务已过期*/
       "data": {
           "isExpired": true
       } 

}

4.1.3: 提交巡更任务结果

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/commitTask

方法：POST

请求参数

名称 位置 类型 必填 描述
taskId body String y 任务ID
status body Int y 任务状态【未开始0，已完成1，未完成2】
devices body Array y 巡更设备
order devices Int y 巡更顺序
devId devices String y 巡更设备ID
devName devices String y 摄像头名称
checkItemCount devices Int y 关联检查项数
checkItems devices Array y 检查项数组
id checkItems String y 检查项Id
content checkItems String y 检查项内容描述
result checkItems JsonObject y 检查项巡更结果
situation result Int y 异常0，正常1
comment result String y 检查项巡更结果备注
startPatrolTime devices String y 开始巡更时间【eg：08:20:25】
duration devices Int y 巡更时长(秒)

请求Body描述(非Form表单数据)

{
    "taskId": "",
    "devices":[
            {
              "order": 1,
              "devId": "",
              "devName": "摄像头01",
              "checkItemCount": 2,
              "checkItems": [
                {
                    "id":"",
                    "content": "有无车辆",
                    "result":{
                        "situation": 1,
                        "comment": "正常"
                    }

                },{
                    "id": "",
                    "content": "有没异物"
                    "result":{
                        "situation": 0,
                        "comment": "不明碟状物体正在靠近"
                    }
                }
              ],
              "startPatrolTime": "08:20:25",
              "duration": 15
            }
     ],
     "events": [{
             "id": 19562,
             "eventName": "",
             "imageUrl": ""
     }]

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

4.1.4: 个人每天任务列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/task/empTaskList

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（0）】
userId body Int y 管家ID
projectId body Int y 项目ID
taskDate body String y 任务日期【eg: 2021-01-07】
pageNo body Int n 当前页码 (默认取值：1)
pageSize body Int n 每页条数 (默认取值：10)

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10,
    "query": {
        "type": {
                "$eq": 0
        },
        "userId": {
                "$eq": 9247
        },
        "projectId": {
                "$eq": 610
        },
        "taskDate": {
                "$eq": "2021-01-08"
        }
    },
    "order": {
        "createTime": "desc"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
count data int y 总条数
list data Array y 任务列表
taskTime list String y 任务时间点
name list STRING y 任务名称
username list STRING n 巡更人名称
deviceCount list int y 巡更设备数
cycleType list STRING y 任务周期: day、week、month
patrolTime list String y 巡更时间段【08:00-10:00】
startDate list String y 巡更计划开始时间
endDate list String y 巡更计划结束时间

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
      "count": 10,
      "list": [
          {
            "taskTime": "2020-02-02 12:12:12",
            "name": "",
            "userName": "",
            "deviceCount": 7,
            "cycleTyepe": "week",
            "patrolTime": "08:00-10:00",
            "startDate": "2020-02-12", 
            "endDate": "2020-02-13" 
        }
      ]
  }
}

4.1.5: 个人每天任务完成率

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/patrol/task/empTaskCP

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（0）】
userId body Int y 管家ID
projectId body Int y 项目ID
taskDate body String y 任务日期【eg: 2021-01-07】

请求Body描述(非Form表单数据)

{
    "query": {
        "type": {
                "$eq": 0
        },
        "userId": {
                "$eq": 2314
        },
        "projectId": {
                "$eq": 610
        }
        "taskDate": {
                "$eq": "2020-12-09"
        }
    },
    "order": {
        "createTime": "desc"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
donePercentage 顶层 STRING 任务完成率【eg】

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
         "donePercentage": "80.5%"
  }
}

4.1.6: 获取视频设备巡更进展详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/patrol/task/devPatrolSituation

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（0）】
taskId body String y 任务ID
projectId body Int y 项目ID

请求Body描述(非Form表单数据)

{
    "type": 0,
    "taskId": "",
    "projectId": 23414
}

返回参数

名称 位置 类型 描述
code 顶层 String 响应码标识
message 顶层 String 响应消息文本
data 顶层 JSONObject 响应数据对象
patrolSituation data Array 巡更情况列表
flag data Int 设备巡更完成标识，取值1
devId patrolSituation String 设备ID
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": {
        "patrol_situation" : [
        {
            "devId" : "eabbacf952663902",
            "devTemplate" : "cs001",
            "macAddress" : "dsg555gg",
            "flag" : 1,
            "checkItemCount" : 10,
            "devName" : "测试001",
            "results" : [
                {
                    "result" : {
                        "comment" : "答对1",
                        "situation" : 1
                    },
                    "id" : "5fcf7cd378b3f54bb8412f2c",
                    "content" : "111111"
                }
            ],
            "order" : 1
        }
    ]
  }
}

results matching ""

    No results matching ""