4.2 图片巡更任务API

API列表

编号 API名称 路径 版本
4.2.1 巡更任务分页 /v1/iot/patrol/task/page 1.0
4.2.2 开始巡更任务 /v1/iot/patrol/task/beginTask 1.0
4.2.3 提交巡更任务结果 /v1/iot/patrol/task/commitTask 1.0
4.2.4 个人每天任务列表 /v1/iot/patrol/task/empTaskList 1.0
4.2.5 个人每天任务完成率 /v1/iot/patrol/task/empTaskCP 1.0

API调用

4.2.1: 巡更任务分页列表

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

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

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

{
    "pageNo": 1,
    "pageSize": 10,
    "query": {
        "type": {
                "$eq": 1
        },
        "projectId": {
                "$eq": 610
        },
        "taskDate": {
                "$gte": "2020-12-12",
                "$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 巡更人名称
devCount list int y 巡更设备数
cycleType list STRING y 任务周期: day、week、month
patrolTime list String y 巡更时间【08:00-10:00】
startDate list date y 巡更计划开始时间
endDate list date y 巡更计划结束时间
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "count": 10,
      "list": [
          {
            "taskTime": "2020-02-02 12:12:12",
            "name": "",
            "userName": "",
            "devCount": 7,
            "cycleTyepe": "day",
            "patrolTime": "08:00-10:00",
            "startDate": "2020-02-12", 
            "endDate": "2020-02-13" 
        }
      ]
  }
}

4.2.2: 开始巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
id body String y 任务ID
type body Int y 计划类型，图片巡更取值1

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

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
order devices Int 巡更顺序
devId devices String 视频设备ID
devName devices String 摄像头名称
devTemplate devices String 设备模板
macAddress devices String MAC地址
checkItemCount devices Int 关联检查项数
fetchImgUri devices String 抓图图片Uri
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": 2314,
                  "devName": "摄像头01",
                  "devTemplate": "xxx(组)",
                  "macAddress": "20-50-63-20",
                  "checkItemCount": 2,
                  "fetchImgUri": "",
                  "checkItems": [
                    {
                        "id":"",
                        "content": "有无车辆",
                         "result": {
                            "comment": null,
                            "situation": 1
                        }
                    },{
                        "id": "",
                        "content": "有没垃圾",
                        "result": {
                            "comment": null,
                            "situation": 1
                        }
                    }
                  ]
                }
            ]
          }      

    /**任务已过期**/
    "data": {
                "isExpired": true
    }
}

4.2.3: 提交巡更任务结果

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
taskId body String y 任务ID
devices body Array y 巡更设备
order devices Int y 巡更顺序
devName devices String y 摄像头名称
checkItemCount devices Int y 关联检查项数
fetchImgUri devices String y 抓图图片Uri
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": "",
    "status": 2,
    "devices":[
            {
              "order": 1,
              "devId": "",
              "devName": "摄像头01",
              "checkItemCount": 2,
              "fetchImgUri": "",
              "checkItems": [
                {
                    "id":"",
                    "content": "有无车辆",
                    "result":{
                        "situation": 1,
                        "comment": "正常"
                    }

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

}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

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

4.2: 新增巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（1）】
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": {

  }
}

4.3: 巡更任务详情

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

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

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

{
    "id": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
id data String y 主键ID
type data Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（1）】
taskDate data Date n 任务日期
name data String n 视频巡更任务名称
username data String n 巡更人
devCount data Int n 巡更设备数
cycleType data String n 任务周期【每天(week)、每周(week)、每月(month)】
patrolTimes data Array y 巡更时间("08:00"、"10:00")
startDate data Date n 计划开始时间
endDate data Date n 计划结束时间
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "type": 1,
    "taskDate": "2020-01-01",
    "name": "图片任务01",
    "username": "张三",
    "devCount": 7,
       "cycleType": "day",
    "patrolTimes": ["08:00","10:00"],
    "startDate": "2020-01-01",
    "endDate": "2020-01-03"
  }
}

4.4: 修改巡更任务

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
Id body Int y 任务主键ID
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（1）】
taskDate body Date n 任务日期
name body String n 视频巡更任务名称
username body String n 巡更人
devCount body Int n 巡更设备数
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表单数据)

{
    ”id“: ""
    "type": 1,
    "taskDate": "2020-01-01",
    "name": "图片任务01",
    "username": "张三",
    "devCount": 7,
       "cycleType": "day",
    "patrolTimes": ["08:00","10:00"],
    "startDate": "2020-01-01",
    "endDate": "2020-01-03"
}

返回信息

返回参数类型

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 String y 主键ID

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

{
    "id": ""
}

返回信息

返回参数类型

JSON

返回参数

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

  }
}

4.2.4: 个人每天任务列表

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更和图片巡更的任务类型，这里取值（1）】
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": 1
        },
        "userId": {
                "$eq": 2314
        },
        "projectId": {
                "$eq": 610
        }
        "taskDate": {
                "$eq": "2020-12-09"
        }
    },
    "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.5: 个人每天任务完成率

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

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

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

{
    "query": {
        "type": {
                "$eq": 1
        },
        "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%"
  }
}

results matching ""

    No results matching ""