3.1视频巡更计划API

API列表

编号 API名称 路径 版本
3.1.1 新增巡更计划 /v1/iot/patrol/plan/add 1.0
3.1.2 巡更计划分页 /v1/iot/patrol/plan/page 1.0
3.1.3 巡更计划详情 /v1/iot/patrol/plan/detail 1.0
3.1.4 修改巡更计划 /v1/iot/patrol/plan/update 1.0
3.1.5 删除巡更计划 /v1/iot/patrol/plan/remove 1.0
3.1.6 巡更计划启用状态修改 /v1/iot/patrol/plan/bootOrder 1.0
3.1.7 计划名称重复校验 /v1/iot/patrol/plan/nameCheckOut 1.0

API调用

3.1.1: 新增巡更计划

描述 视频巡更计划新增接口，重复周期：每天；巡更方式：设定时间巡更

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/add

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
projectId body String y 所属项目ID
name body string y 巡更计划名称
startDate body String y 计划开始时间
endDate body String y 计划结束时间
cycleType body string y 巡更重复周期(day：每天，week：每周，month：每月)
cycleData body Array n 巡更重复周期内数据：按天/周/月，提交不同的数据集合
patrolType body Int y 巡更方式(1：设定时间内随机巡更，2：设定时间巡更，3：固定间隔时间巡更)
startTime body String n 巡更时间段开始时间时刻（"08:00"）
endTime body String n 巡更时间段开始结束时刻（"10:00"）
patrolTimes body Array n 巡更方式为2时的传送参数：巡更时间(数组形式：["08:00","10:00","12:30"])
remindTime body String y 巡更提醒时间(小时)
videoDuration body long y 视频查看时长(秒)
devices body Array y 巡更设备关联数组集合
order devices Int y 巡更顺序
devId devices Int y 视频设备ID
devName devices String y 摄像头名称
devTemplate devices String y 设备模板
macAddress devices String y MAC地址
checkItemCount devices Int y 关联检查项数
checkItems devices Array y 关联检查项的数组
id checkItems String y 检查项主键ID
content checkItems String y 检查项内容描述
execTargetType body string y 执行对象类型(person：个人，group：员工组)
execTarget body Array y 执行对象(数组)
execTerm body Object y 运行终端
intervalTime body String n 间隔时间(小时)
frequency body Int n 随机巡更次数(对多不超过10次)，巡更方法方式为1时需传参

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

{
    "type": 0,
    "projectId": "610",
    "name": "巡更计划01",
    "startDate": "2020-02-12",
    "endDate": "2020-02-13",
    "cycleType": "day",
    "cycleData": [1,2,3,4,5,6,0]
    "patrolType": 1,
    "startTime": "08:00",
    "endTime": "10:00",
    "patrolTimes": [
        "08:00",
        "10:00"
    ],
    "remindTime": "0.5",
    "videoDuration": 50,
    "devices":[
        {
          "order": 1,
          "devId": 2314,
          "devName": "摄像头01",
          "devTemplate": "xxx(组)",
          "macAddress": "20-50-63-20",
          "checkItemCount": 2,
          "checkItem": [
              { "id": "",
                "content": ""
              },{}
          ]
        }
    ],
    "execTargetType": "person",
    "execTarget": [{
        "username": "李四",
        "userId": 1234
      },{
        "username": "张三",
        "userId": 5678
    }],
    "execTerm": {
        "ioc": 0,
        "app": 1
    },
   "intervalTime": "0.5",
    "frequency": 3
}

返回信息

返回参数类型

JSON

返回参数

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

3.1.2: 巡更计划分页列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/page

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
pageNo body int n 当前页码 (默认为：1)
pageSize body int n 每页条数 (默认为：10)
projectId 顶部 Int n 项目ID
bootStatus 顶部 String n 启用状态【已启动：1 未启动：0】
name 顶部 String n 计划名称---模糊搜索

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

{
    "pageNo": 1,
    "pageSize": 10,
    "query": {
        "projectId": {
                  "$eq": 610 
        },
        "bootStatus": {
                "$eq": 0
        },
        "type": {
                "$eq": 0
        },
        "name": {
                "$like": "领贤xx"
        }
    },
    "order": {
        "createTime": "desc"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
count data Int 总条数
list data Array 列表
id records STRING 主键ID
name records string 巡更计划名称
devCount records Int 巡更设备数
cycleType records string 重复周期
patrolType records string 重复类型
patrolTime records String 巡更时间段
frequency records Int 频次
status records Int 状态标记：【完成1，未完成0】
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "count": 10,
      "list": [
          {
      "id": "",
      "name": "",
      "devCount": 7,
      "cycleType": "每天",
      "patrolType": "固定日",
      "patrolTime": [
        "08:00",
        "10:00"
      ],
      "frequency": 0,
      "status": 1
    }
      ]
  }
}

3.1.3: 巡更计划详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
id body String y 主键ID

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

{
    "type": 0
    "id": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
id data String 主键ID
type data Int 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
projectId data String 所属项目ID
name data string 巡更计划名称
startDate data date 计划开始时间
endDate data date 计划结束时间
cycleType data string 巡更重复周期(day：每天，week：每周，month：每月)
cycleData data Array 巡更重复周期内数据：按天/周/月，提交不同的数据集合
patrolType data Int 巡更方式(1：设定时间内随机巡更，2：设定时间巡更，3：固定间隔时间巡更)
startTime data String 巡更时间段开始时间时刻（"08:00"）
endTime data String 巡更时间段开始结束时刻（"10:00"）
patrolTimes data Array 巡更方式为2时的传送参数：巡更时间(数组形式：["08:00","10:00","12:30"])
remindTime data Int 巡更提醒时间(小时)
videoDuration data long 视频查看时长(秒)
devices data Array 巡更设备关联数组集合
order devices Int 巡更顺序
devName devices String 摄像头名称
devTemplate devices String 设备模板
macAddress devices String MAC地址
checkItemCount devices Int 关联检查项数
checkItems devices Array 关联检查项的数组
id checkItems String 检查项主键ID
content checkItems String 检查项内容描述
execTargetType data string 执行对象类型(person：个人，group：员工组)
execTarget data Array 执行对象类型(数组)
execTerm data Object 运行终端
intervalTime data String 间隔时间(小时)
frequency data Int 频次
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "type": 0,
      "id": "t3jp5pop36p",
    "projectId": "610",
    "name": "巡更计划01",
    "startDate": "2020-02-12",
    "endDate": "2020-02-13",
    "cycleType": "day",
    "cycleData": [1,2,3,4,5,6,7]
    "patrolType": 1,
    "startTime": "08:00",
    "endTime": "10:00",
    "patrolTimes": [
        "08:00",
        "10:00"
    ],
    "remindTime": "0.5",
    "videoDuration": 50,
    "devices":[
        {
          "order": 1,
          "devName": "摄像头01",
          "devTemplate": "xxx(组)",
          "macAddress": "20-50-63-20",
          "checkItemCount": 2,
          "checkItem": [
              { "id": "",
                "content": ""
              },{}
          ]
        }
    ],
    "execTargetType": "person",
    "execTarget": [{
        "username": "李四",
        "userId": 1234
      },{
        "username": "张三",
        "userId": 5678
    }],
    "execTerm": {
        "ioc": 0,
        "app": 1
    },
   "intervalTime": "0.5",
   "frequency": 3
  }
}

3.1.4: 修改巡更计划

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/update

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
id body String y 主键ID
projectId body String y 所属项目ID
name body string y 巡更计划名称
startDate body date y 计划开始时间
endDate body date y 计划结束时间
cycleType body string y 巡更重复周期(day：每天，week：每周，month：每月)
cycleData body Array n 巡更重复周期内数据：按天/周/月，提交不同的数据集合
patrolType body Int y 巡更方式(1：设定时间内随机巡更，2：设定时间巡更，3：固定间隔时间巡更)
startTime body String y 巡更时间段开始时间时刻（"08:00"）
endTime body String y 巡更时间段开始结束时刻（"10:00"）
patrolTimes body Array y 巡更方式为2时的传送参数：巡更时间(数组形式：["08:00","10:00","12:30"])
frequency body Int y 频次
remindTime body Int y 巡更提醒时间(小时)
videoDuration body long y 视频查看时长(秒)
devices body Array y 巡更设备关联数组集合
order devices Int y 巡更顺序
devId devices Int y 设备Id
devName devices String y 摄像头名称
devTemplate devices String y 设备模板
macAddress devices String y MAC地址
checkItemCount devices Int y 关联检查项数
checkItems devices Array y 关联检查项的ID数组
id checkItems String y 检查项主键ID
content checkItems String y 检查项内容描述
execTargetType body string y 执行对象类型(person：个人，group：员工组)
execTarget body Array y 执行对象类型(数组)
execTerm body Object y 运行终端
intervalTime body String y 间隔时间(小时)
bootStatus body Int n 计划已启用：1 未启用：0

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

{
    "type": 0,
    "id": "02tr89ijo989",
    "projectId": "610",
    "name": "巡更计划01",
    "startDate": "2020-02-12",
    "endDate": "2020-02-13",
    "cycleType": "day",
    "cycleData": [1,2,3,4,5,6,7]
    "patrolType": 1,
    "startTime": "08:00",
    "endTime": "10:00",
    "patrolTimes": [
        "08:00",
        "10:00"
    ],
    "frequency": 3,
    "remindTime": "0.5",
    "videoDuration": 50,
    "devices":[
        {
          "order": 1,
          "devName": "摄像头02",
          "devId":2360,
          "devTemplate": "xxx(组)",
          "macAddress": "20-50-63-20",
          "checkItemCount": 2,
          "checkItem": [
              { "id": "",
                "content": ""
              },{}
          ]
        }
    ],
    "execTargetType": "person",
    "execTarget": [{
        "username": "李四",
        "userId": 1234
      },{
        "username": "张三",
        "userId": 5678
    }],
    "execTerm": {
        "ioc": 0,
        "app": 1
    },
   "intervalTime": "0.5",
    "bootStatus": 0
}

返回信息

返回参数类型

JSON

返回参数

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

3.1.5: 删除巡更计划

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/remove

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
id body String y 主键ID

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

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

返回信息

返回参数类型

JSON

返回参数

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

  }
}

3.1.6: 巡更计划启用状态修改

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/bootOrder

方法：POST

请求参数

名称 位置 类型 必填 描述
type body Int y 巡更类型【区分视频巡更计划和图片巡更计划，这里取值（0）】
id body String y 计划ID
bootStatus body Int y 启用状态：未启用0，已启用1

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

{
    "type":0, 
    "id": "",
    "bootStatus": 1
}

返回信息

返回参数类型

JSON

返回参数

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

  }
}

3.1.7: 计划名称重复校验

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/patrol/plan/nameCheckOut

方法：POST

请求参数

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

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

{
    "type":0, 
    "name": "",
    "projectId": 610
}

返回信息

返回参数类型

JSON

返回参数

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

  }
}

{
  "code": 0,
  "message": "该命名已存在，请重新输入",
  "data": {

  }
}

results matching ""

    No results matching ""