1. 设备区域树管理

设备区域树管理

1.1. 新增区域

基础信息

路径: /v1/api/zone/add

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
name string 是 区域名
parentUuid string 是 上级区域uuid, 顶级的默认区域uuid为0
description string 否 区域说明

Body示例:

{
    "name": "区域2",
    "parentUuid": "0",
    "description": "描述"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 否 区域uuid

响应示例:

{
    "code":0,
    "data":{
        "uuid":"bff40c3085064627bfc17e59bd1c1619"
    },
    "msg":"成功"
}

1.2. 修改区域信息

基础信息

路径: /v1/api/zone/update

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 区域uuid
name string 否 区域名
description string 否 区域说明

Body示例:

{
   "uuid": "5bd3b9b087174343a6b8ea2edbe5d07d",
   "name": "区域3"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
    "code":0,
    "msg":"成功"
}

1.3. 删除区域

基础信息

路径: /v1/api/zone/delete

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 区域uuid

Body示例:

{
  "uuid": "5bd3b9b087174343a6b8ea2edbe5d07d"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
    "code":0,
    "msg":"成功"
}

1.4. 区域树查询

基础信息

路径: /v1/api/zone/tree

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
queryType integer 否 4 查询类型
1 :门禁点树，返回数据包含区域节点和门禁点节点
2 :监控点树，返回数据包含区域节点和监控点节点
3 :设备树，返回数据包含区域节点和设备节点
4 :区域树，返回数据仅含区域节点
rootZoneUuid string 否 0 区域树查询起点, 如果不传则是根区域
name string 否 区域名称，支持模糊匹配
pointName string 否 点位名称， 支持模糊匹配
hasOnDemand boolean 否 false 是否按需加载, 默认全量
countType integer 否 0 统计数量类型，默认不统计
0 :不统计，默认
1 :统计门禁点数量
2 :统计监控点数量
3 :统计设备数量
onlyRoot boolean 否 false 是否仅查询根区域，仅按需加载生效，默认否
queryParentInfo boolean 否 false 是否查询父区域信息，默认否
videoMonitorType integer 否 视频监控点查询 1-实时预览 2-录像回放

Body示例:

{
    "queryType": 4,
    "hasOnDemand": true,
    "countType": 3,
    "hasCountDevice": true,
    "rootZoneUuid": "0"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data array 否 具体的返回值
  |─ object
    |─nodeType integer 否 节点类型
1 :区域节点
2 :设备节点
3 :门禁点节点
4 :监控点节点
    |─uuid string 否 区域uuid
    |─name string 否 区域名字
    |─level integer 否 区域层级
    |─parentUuid string 否 上级区域uuid
    |─parentName string 否 父节点名字
    |─sortNum integer 否 排序值
    |─hasAuth boolean 否 区域是否有权限
    |─description string 否 区域说明
    |─onlineTotalNum integer 否 在线数
    |─totalNum integer 否 总数
    |─hasLeaf boolean 否 是否是叶子节点
    |─deviceUuid string 否 设备uuid
    |─deviceName string 否 设备名称
    |─deviceZoneUuid string 否 设备区域uuid
    |─pointUuid string 否 点位uuid
    |─pointName string 否 点位名称
    |─pointZoneUuid string 否 点位区域uuid
    |─pointStatus integer 否 点位状态
-2 :初始化异常
3 :在线
4 :离线

响应示例:

{
    "code":0,
    "data":[
        {
            "description":"",
            "hasAuth":true,
            "hasLeaf":true,
            "level":2,
            "name":"武汉",
            "nodeType":1,
            "onlineTotalNum":1,
            "parentUuid":"0",
            "sortNum":5,
            "totalNum":3,
            "uuid":"8d4beeb8e6cc45ef9d5ed0672b70ab68"
        },
        {
            "description":"",
            "hasAuth":true,
            "hasLeaf":true,
            "level":2,
            "name":"LX2",
            "nodeType":1,
            "onlineTotalNum":0,
            "parentUuid":"0",
            "sortNum":2,
            "totalNum":1,
            "uuid":"24f9efe9304147f7a341009980bb33a7"
        },
        {
            "description":"",
            "hasAuth":true,
            "hasLeaf":false,
            "level":2,
            "name":"LX",
            "nodeType":1,
            "onlineTotalNum":1,
            "parentUuid":"0",
            "sortNum":1,
            "totalNum":1,
            "uuid":"7e3e91c18aca4150874272bee5b94c5f"
        },
        {
            "description":"",
            "hasAuth":true,
            "hasLeaf":true,
            "level":2,
            "name":"ls",
            "nodeType":1,
            "onlineTotalNum":0,
            "parentUuid":"0",
            "sortNum":3,
            "totalNum":0,
            "uuid":"b6847085f5294fa8b348d63ce9bf39d6"
        },
        {
            "description":"",
            "hasAuth":true,
            "hasLeaf":true,
            "level":2,
            "name":"hw",
            "nodeType":1,
            "onlineTotalNum":0,
            "parentUuid":"0",
            "sortNum":4,
            "totalNum":0,
            "uuid":"877003b9040c4416bfebb396eb38d54b"
        },
        {
            "description":"描述",
            "hasAuth":true,
            "hasLeaf":true,
            "level":2,
            "name":"区域2",
            "nodeType":1,
            "onlineTotalNum":0,
            "parentUuid":"0",
            "sortNum":7,
            "totalNum":0,
            "uuid":"bff40c3085064627bfc17e59bd1c1619"
        }
    ],
    "msg":"成功"
}

results matching ""

    No results matching ""