1. 点位管理

点位管理


1.1. 添加点位

基础信息

路径: /v1/api/devicePoint/add

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
type integer 是 点位类型
1 :门禁点
2 :监控点
zoneUuid string 是 区域uuid
name string 是 名称
hasFocusPerson boolean 否 false 是否检测关注人员(仅门禁点用)
location string 否 位置
gbCode string 否 GB编码
remark string 否 备注
doorDeviceUuid string 否 门禁点关联设备uuid
doorChannelUuid string 否 门禁点关联通道uuid
monitorVideoDeviceUuid string 否 监控点视频流设备uuid
monitorVideoChannelUuid string 否 监控点视频流通道uuid
monitorComputerDeviceUuid string 否 监控点智能设备uuid
monitorComputerChannelUuid string 否 监控点智能设备通道uuid
direction integer 否 门禁点方向默认不传递为进 1-进 2-出

Body示例:

{
    "type": 2,
    "zoneUuid": "0",
    "name": "监控点1",
    "remark": "说的",
    "monitorVideoDeviceUuid": "",
    "monitorComputerDeviceUuid": "DE-8b31289374c34bafa627a614ab9fa850",
    "monitorComputerChannelUuid": "CH-5810f0b83716476d873a",
    "direction":1
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.2. 批量删除点位

基础信息

路径: /v1/api/devicePoint/deletes

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuidList array 是 uuid列表
  |─ string

Body示例:

{
    "uuidList": ["db86a189e7c84aa2b36ba81e017af96e"]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.3. 更新点位信息(不包含关联通道)

基础信息

路径: /v1/api/devicePoint/update

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 是 点位uuid
zoneUuid string 否 区域uuid
name string 否 名称
location string 否 位置
remark string 否 备注
relayIp string 否 继电器IP,用于门禁点绑定继电器
hasFocusPerson boolean 否 false 是否检测关注人员
hasDelControl boolean 否 false 变更区域时是否同时删除门禁布控, 默认否
direction integer 否 门禁点方向默认不传递为进 1-进 2-出

Body示例:

{
    "type": 2,
    "uuid": "89244379064843b28a735fb82056393a",
    "zoneUuid": "0",
    "name": "监控点2",
    "remark": "说的哈"
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.4. 分页查询点位列表

基础信息

路径: /v1/api/devicePoint/list

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pageNum integer 否 1 当前页码,不传默认1
pageSize integer 否 20 分页大小,不传默认20
queryType integer 否 1 查询类型 1-资源点位列表(默认值) 2-门禁控制列表
controlType integer 否 布控类型 1-门禁布控 2-结构化布控 3-安防布控 4-人数统计布控
personCtrlComputer boolean 否 false 仅查询人员布控算力资源(所有有权限的监控点和面板机所属的门禁点)
videoMonitorType integer 否 视频监控点查询 1-实时预览 2-录像回放
type integer 是 1 点位类型
1 :门禁点
2 :监控点
rootZoneUuid string 否 0 查询点位的起始节点, 不传则为根区域
hasCurrentZone boolean 否 true 是否仅查询当前区域 true-仅查当前区域 false-查询当前区域和所有子区域, 默认true
name string 否 名称
gbCode string 否 GB编码
hasFocusPerson boolean 否 是否检测关注人员
abilitySet array 否 能力集
  |─ integer
gateStatus integer 否 开关状态
0 :关
1 :开
2 :无门磁
3 :常开
4 :常闭
5 :异常
6 :未知
doorDeviceName string 否 门禁点所属设备名称
doorDeviceIp string 否 门禁点所属设备IP
doorDeviceModelBelong integer 否 门禁点所属设备归属类型
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
doorStatus integer 否 门禁点在线状态
-2 :初始化异常
3 :在线
4 :离线
monitorVideoDeviceCode string 否 监控点视频流设备编码
monitorVideoDeviceName string 否 监控点视频流设备名称
monitorVideoDeviceIp string 否 监控点视频流设备IP
monitorVideoChannelNo integer 否 监控点视频流通道号
monitorVideoChannelName string 否 监控点视频流通道名称
monitorComputerDeviceCode string 否 监控点智能设备编码
monitorComputerDeviceName string 否 监控点智能设备名称
monitorComputerDeviceIp string 否 监控点智能设备IP
monitorComputerChannelNo integer 否 监控点智能设备通道号
monitorComputerChannelName string 否 监控点智能设备通道名称
monitorComputerDeviceModelBelong integer 否 监控点智能设备归属类型
userUuid string 否
direction integer 否 门禁点方向默认不传递为进 1-进 2-出

Body示例:

{
    "pageNum": 1,
    "pageSize": 2,
    "queryType": 1
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─pageNum integer 是 页码,从1开始
当前页码
  |─pageSize integer 是 页面大小
分页大小
  |─total integer 是 总记录数
总数
  |─list array 否
    |─ object
      |─uuid string 是 uuid
      |─type integer 是 类型
1 :门禁点
2 :监控点
      |─zoneUuid string 是 所属区域
      |─zoneName string 否 所属区域名称
      |─name string 是 名称
      |─relayIp string 否 继电器设备IP
      |─gbCode string 否 GB编码
      |─location string 否 位置
      |─remark string 否 备注
      |─status integer 否 点位状态
-2 :初始化异常
3 :在线
4 :离线
      |─gateStatus integer 否 开关状态
0 :关
1 :开
2 :无门磁
3 :常开
4 :常闭
5 :异常
6 :未知
      |─personSyncNum integer 否 底库下发数量
      |─personTotalNum integer 否 底库总数量
      |─hasFocusPerson boolean 否 是否检测关注人员
      |─abilitySet array 否 能力集
        |─ integer
      |─abilitySetText array 否 能力集描述
        |─ string
      |─doorDeviceUuid string 否 门禁点关联设备uuid
      |─doorDeviceCode string 否 门禁点关联设备编码
      |─doorDeviceName string 否 门禁点关联设备名称
      |─doorDeviceIp string 否 门禁点关联设备IP
      |─doorDeviceSnCode string 否 门禁点关联设备sn码
      |─doorDeviceModelType integer 否 设备类型
1 :智能摄像头
2 :智能面板机
3 :智能中心服务器
4 :网络摄像机
5 :存储服务器
6 :门禁控制器
7 :智能边缘服务器
2000 :人证机
      |─doorDeviceModelBelong integer 否 门禁点设备归属类型
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
      |─doorChannelUuid string 否 门禁点关联通道uuid
      |─doorChannelName string 否 门禁点关联通道名称
      |─doorChannelNo integer 否 门禁点关联通道号
      |─monitorVideoDeviceUuid string 否 监控点视频流设备uuid
      |─monitorVideoDeviceCode string 否 监控点视频流设备编码
      |─monitorVideoDeviceName string 否 监控点视频流设备名称
      |─monitorVideoDeviceIp string 否 监控点视频流设备IP
      |─monitorVideoDeviceSnCode string 否 监控点视频流设备sn码
      |─monitorVideoChannelUuid string 否 监控点视频流通道uuid
      |─monitorVideoChannelName string 否 监控点视频流通道名称
      |─monitorVideoChannelNo integer 否 监控点视频流通道号
      |─monitorComputerDeviceUuid string 否 监控点智能设备uuid
      |─monitorComputerDeviceCode string 否 监控点智能设备编码
      |─monitorComputerDeviceName string 否 监控点智能设备名称
      |─monitorComputerDeviceIp string 否 监控点智能设备IP
      |─monitorComputerDeviceSnCode string 否 监控点智能设备sn码
      |─monitorComputerChannelUuid string 否 监控点智能设备通道uuid
      |─monitorComputerChannelName string 否 监控点智能设备通道名称
      |─monitorComputerChannelNo integer 否 监控点智能设备通道号
      |─monitorComputerDeviceModelCode integer 否 监控点智能设备型号
      |─monitorComputerDeviceModelBelong integer 否 监控点智能设备归属类型
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
      |─enableAlwaysOperation boolean 否 是否支持常开常闭 取消常开 取消常闭的操作
      |─direction integer 否 门禁点方向默认不传递为进 1-进 2-出

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "abilitySet":[
                    3,
                    4,
                    1
                ],
                "abilitySetText":[
                    "识别",
                    "全结构化",
                    "视频"
                ],
                "doorChannelName":"算力引擎1_1",
                "doorChannelNo":1,
                "doorChannelUuid":"CH-5810f0b83716476d873a",
                "doorDeviceIp":"169.254.255.10",
                "doorDeviceModelBelong":16,
                "doorDeviceModelType":7,
                "doorDeviceName":"算力引擎1",
                "doorDeviceUuid":"DE-8b31289374c34bafa627a614ab9fa850",
                "enableAlwaysOperation":false,
                "hasFocusPerson":true,
                "name":"算力引擎1-通道1",
                "personTotalNum":300000,
                "status":3,
                "type":1,
                "uuid":"697a5e73a2fe444fa9bda7cdb551867a",
                "zoneName":"默认区域",
                "zoneUuid":"0"
            },
            {
                "abilitySet":[
                    3,
                    4,
                    1
                ],
                "abilitySetText":[
                    "识别",
                    "全结构化",
                    "视频"
                ],
                "doorChannelName":"算力引擎1_5",
                "doorChannelNo":5,
                "doorChannelUuid":"CH-8d8910a371764aae85b4",
                "doorDeviceIp":"169.254.255.10",
                "doorDeviceModelBelong":16,
                "doorDeviceModelType":7,
                "doorDeviceName":"算力引擎1",
                "doorDeviceUuid":"DE-8b31289374c34bafa627a614ab9fa850",
                "enableAlwaysOperation":false,
                "hasFocusPerson":true,
                "location":"",
                "name":"LZX-盒子门禁点别动",
                "personTotalNum":300000,
                "status":3,
                "type":1,
                "uuid":"6cca012602e64216b4f601c24d77c65a",
                "zoneName":"默认区域",
                "zoneUuid":"0"
            }
        ],
        "pageNum":1,
        "pageSize":2,
        "total":3
    },
    "msg":"成功"
}

1.5. 查询点位详情

基础信息

路径: /v1/api/devicePoint/queryByUuid

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
    "uuid": "697a5e73a2fe444fa9bda7cdb551867a"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 是 uuid
  |─type integer 是 类型
1 :门禁点
2 :监控点
  |─zoneUuid string 是 所属区域
  |─zoneName string 否 所属区域名称
  |─name string 是 名称
  |─relayIp string 否 继电器设备IP
  |─gbCode string 否 GB编码
  |─location string 否 位置
  |─remark string 否 备注
  |─status integer 否 点位状态
-2 :初始化异常
3 :在线
4 :离线
  |─gateStatus integer 否 开关状态
0 :关
1 :开
2 :无门磁
3 :常开
4 :常闭
5 :异常
6 :未知
  |─personSyncNum integer 否 底库下发数量
  |─personTotalNum integer 否 底库总数量
  |─hasFocusPerson boolean 否 是否检测关注人员
  |─abilitySet array 否 能力集
    |─ integer
  |─abilitySetText array 否 能力集描述
    |─ string
  |─doorDeviceUuid string 否 门禁点关联设备uuid
  |─doorDeviceCode string 否 门禁点关联设备编码
  |─doorDeviceName string 否 门禁点关联设备名称
  |─doorDeviceIp string 否 门禁点关联设备IP
  |─doorDeviceSnCode string 否 门禁点关联设备sn码
  |─doorDeviceModelBelong integer 否 门禁点设备归属类型
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
  |─doorChannelUuid string 否 门禁点关联通道uuid
  |─doorChannelName string 否 门禁点关联通道名称
  |─doorChannelNo integer 否 门禁点关联通道号
  |─monitorVideoDeviceUuid string 否 监控点视频流设备uuid
  |─monitorVideoDeviceCode string 否 监控点视频流设备编码
  |─monitorVideoDeviceName string 否 监控点视频流设备名称
  |─monitorVideoDeviceIp string 否 监控点视频流设备IP
  |─monitorVideoDeviceSnCode string 否 监控点视频流设备sn码
  |─monitorVideoChannelUuid string 否 监控点视频流通道uuid
  |─monitorVideoChannelName string 否 监控点视频流通道名称
  |─monitorVideoChannelNo integer 否 监控点视频流通道号
  |─monitorComputerDeviceUuid string 否 监控点智能设备uuid
  |─monitorComputerDeviceCode string 否 监控点智能设备编码
  |─monitorComputerDeviceName string 否 监控点智能设备名称
  |─monitorComputerDeviceIp string 否 监控点智能设备IP
  |─monitorComputerDeviceSnCode string 否 监控点智能设备sn码
  |─monitorComputerChannelUuid string 否 监控点智能设备通道uuid
  |─monitorComputerChannelName string 否 监控点智能设备通道名称
  |─monitorComputerChannelNo integer 否 监控点智能设备通道号
  |─monitorComputerDeviceModelCode integer 否 监控点智能设备型号
  |─monitorComputerDeviceModelBelong integer 否 监控点智能设备归属类型
1 :C3S
2 :C4H
3 :C4N
4 :C4R
5 :C4S
6 :W4K
7 :W5K
8 :B3R
9 :CORE
10 :IPC
11 :NVR
12 :W3K
13 :OTHER_IPC
14 :SMART_IPC
15 :门禁控制器
16 :B4H
17 :人证机
9999 :未知类型
  |─enableAlwaysOperation boolean 否 是否支持常开常闭 取消常开 取消常闭的操作
  |─direction integer 否 门禁点方向默认不传递为进 1-进 2-出

响应示例:

{
    "code":0,
    "data":{
        "abilitySet":[
            3,
            4,
            1
        ],
        "abilitySetText":[
            "识别",
            "全结构化",
            "视频"
        ],
        "doorChannelName":"算力引擎1_1",
        "doorChannelNo":1,
        "doorChannelUuid":"CH-5810f0b83716476d873a",
        "doorDeviceIp":"169.254.255.10",
        "doorDeviceModelBelong":16,
        "doorDeviceName":"算力引擎1",
        "doorDeviceUuid":"DE-8b31289374c34bafa627a614ab9fa850",
        "enableAlwaysOperation":false,
        "hasFocusPerson":true,
        "name":"算力引擎1-通道1",
        "personTotalNum":300000,
        "status":3,
        "type":1,
        "uuid":"697a5e73a2fe444fa9bda7cdb551867a",
        "zoneName":"默认区域",
        "zoneUuid":"0"
    },
    "msg":"成功"
}

1.6. 修改门禁点关联设备

基础信息

路径: /v1/api/devicePoint/updateDoorRelation

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pointUuid string 是 门禁点uuid
deviceUuid string 是 设备uuid
channelUuid string 是 通道uuid

Body示例:

{
    "pointUuid": "697a5e73a2fe444fa9bda7cdb551867a",
    "deviceUuid": "DE-8b31289374c34bafa627a614ab9fa850",
    "channelUuid": "CH-cbc0b9df21e64602a9dd"
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.7. 修改监控点关联设备

基础信息

路径: /v1/api/devicePoint/updateMonitorRelation

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pointUuid string 是 点位uuid
monitorVideoDeviceUuid string 否 监控点视频流设备uuid
monitorVideoChannelUuid string 否 监控点视频流通道uuid
monitorComputerDeviceUuid string 否 监控点智能设备uuid
monitorComputerChannelUuid string 否 监控点智能设备通道uuid

Body示例:

{
    "pointUuid": "5acecaa4778d4f4399fa257a690c10b2",
    "monitorComputerDeviceUuid": "DE-2b68e9e5f1a84175909960a971059590",
    "monitorComputerChannelUuid": "CH-92e037735aed47b99d92"
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.8. 门禁点操作

基础信息

路径: /v1/api/devicePoint/doorControl/operate

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pointUuids array 是 门禁点uuid
  |─ string
operate integer 是 操作类型
1 :开门
2 :远程开门
3 :常开
4 :取消常开
5 :常闭
6 :取消常闭

Body示例:

{
    "pointUuids": ["697a5e73a2fe444fa9bda7cdb551867a"],
    "operate": 2,
    "password": "admin"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─failReason string 否 失败原因

响应示例:

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

1.9. 门禁控制统计

基础信息

路径: /v1/api/devicePoint/doorControl/count

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─onlineTotalNum integer 否 在线数
  |─totalNum integer 否 总数
  |─closeNum integer 否 关门数
  |─alwaysOpenNum integer 否 常开数
  |─alwaysCloseNum integer 否 常闭数

响应示例:

{
    "code":0,
    "data":{
        "alwaysCloseNum":0,
        "alwaysOpenNum":0,
        "closeNum":1,
        "onlineTotalNum":5,
        "totalNum":5
    },
    "msg":"成功"
}

1.10. 编辑通道

基础信息

路径: /v1/api/devicePoint/updateChannel

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
channelUuid string 是 通道uuid
channelName string 否 通道名称
addDoor boolean 否 是否添加为门禁点
addMonitor boolean 否 是否添加为监控点

Body示例:

{
    "channelUuid": "CH-5810f0b83716476d873a",
    "channelName": "算力引擎1_1",
    "addDoor": true,
    "addMonitor": true
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.11. 校验是否布控

基础信息

路径: /v1/api/devicePoint/checkControl

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pointUuidList array 是 点位列表, 只要任意一个点位有布控,都会返回true
  |─ string

Body示例:

{
    "pointUuidList": ["2599d1c5dc214b8a808b4dc7c2f53648"]
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─hasControl boolean 否 是否布控

响应示例:

{
    "code":0,
    "data":{
        "hasControl":false
    },
    "msg":"成功"
}

1.12. 获取面板机meglink协议版本

基础信息

路径: /v1/api/devicePoint/getPadProtocolVersion

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
    "uuid": "5b99d4e34c2745eb803ab63e8520ae54"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─protocolVersion integer 否 协议版本 1-meglink v2 2-meglink v3

响应示例:

{
    "code":0,
    "data":{
        "protocolVersion":2
    },
    "msg":"成功"
}

results matching ""

    No results matching ""