2. 视频分组及视频类型管理API

API列表

编号 API名称 路径 版本
2.1 新增视频分组及视频类型管理 /v1/iot/video/dictionary/add 1.0
2.2 视频分组及视频类型管理详情 /v1/iot/video/dictionary/detail 1.0
2.3 修改视频分组及视频类型管理 /v1/iot/video/dictionary/update 1.0
2.4 删除视频分组及视频类型管理 /v1/iot/video/dictionary/remove 1.0
2.5 视频分组及视频类型管理列表 /v1/iot/video/dictionary/list 1.0
2.6 视频分组及视频类型管理分页 /v1/iot/video/dictionary/page 1.0

API调用

2.1: 新增视频分组及视频类型管理

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/dictionary/add

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 类型名称
code body string n 顶级业务组织Code
type body string y 字典类型：[videoGroup]表示视频分组，[cameraType]表示视频类型

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

{
  "name": "固定属性",
  "code": "100",
  "type": "videoGroup"
}

返回信息

返回参数类型

JSON

返回参数

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

2.2: 视频分组及视频类型管理详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/dictionary/detail

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
name data string y 类型名称
code data string n 顶级业务组织Code
type data string y 字典类型：[videoGroup]表示视频分组，[cameraType]表示视频类型
id data int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "name": "固定属性",
  "code": "persistent",
  "type": "dataPointProperty"
  }
}

2.3: 修改视频分组及视频类型管理

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/dictionary/update

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 类型名称
code body string n 顶级业务组织Code
type body string y 字典类型：[videoGroup]表示视频分组，[cameraType]表示视频类型
id body int y 主键id

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

{
    "id": 1,
    "name": "固定属性",
  "code": "persistent",
  "type": "dataPointProperty"
}

返回信息

返回参数类型

JSON

返回参数

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

2.4: 删除视频分组及视频类型管理

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/dictionary/remove

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

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

2.5: 视频分组及视频类型管理列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/dictionary/list

方法：POST

请求参数

名称 位置 类型 必填 描述

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
name data string y 类型名称
code data string n 顶级业务组织Code
type data string y 字典类型：[videoGroup]表示视频分组，[cameraType]表示视频类型
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "固定属性",
      "code": "persistent",
      "type": "dataPointProperty"
        }
      ]
  }
}

2.6: 视频分组及视频类型管理分页列表/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/video/dictionary/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 每页条数
pageNo body int y 当前页数

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

{
    "pageNo": 1,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
total data int y 总条数
records data Array y 列表
name data string y 类型名称
code data string n 顶级业务组织Code
type data string y 字典类型：[videoGroup]表示视频分组，[cameraType]表示视频类型
id records int y 主键id
返回结果示例

,，

{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "固定属性",
      "code": "persistent",
      "type": "dataPointProperty"
        }
      ]
  }
}

results matching ""

    No results matching ""