1. 访客支持的门禁权限接口

1.1. 添加访客门禁权限布控

基础信息

路径: /v1/api/access/deploy/visitor/add

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
name string 是 布控权限名称，全局唯一
personGroupUuids array 是 人员组uuids
  |─ string
pointUuids array 否 门禁点uuids，按门禁点布控时必传
  |─ string
pointGroupUuids array 否 门禁点组uuids，按门禁点组布控时必传
  |─ string
scheduleUuid string 否 时间计划uuid,选填,默认全天时间计划

Body示例:

{
  "name": "测试访客门禁布控",
  "personGroupUuids": [
    "b7e8182480b5482590d2828f3422d59a"
  ],
  "pointUuids": [
    "e0ccbd3bf5b6458daf67a461e1e77ad8"
  ]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.2. 查询访客门禁权限布控详情

基础信息

路径: /v1/api/access/deploy/visitor/detail

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 是 布控记录uuid

Body示例:

{
  "uuid": "def48ec1511e4f728aa2da1b68f2fea7"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 否 布控权限uuid
  |─name string 否 布控权限名称
  |─personGroups array 否 人员组信息，按人员组布控时必传
    |─ object
      |─groupUuid string 否 人员组uuid
      |─groupName string 否 人员组名称
  |─points array 否 门禁点信息，按门禁点布控时必传
    |─ object
      |─pointUuid string 否 门禁点uuid
      |─pointName string 否 门禁点名称
      |─pointZoneName string 否 门禁点区域名称
      |─location string 否 门禁点位置
      |─deviceName string 否 所属设备
  |─pointGroups array 否 门禁点组信息，按门禁点组布控时必传
    |─ object
      |─groupUuid string 否 门禁点组uuid
      |─groupName string 否 门禁点组名称
  |─scheduleUuid string 否 时间计划uuid

响应示例:

{
    "code":0,
    "data":{
        "name":"测试访客门禁布控",
        "personGroups":[
            {
                "groupName":"test-visitor",
                "groupUuid":"b7e8182480b5482590d2828f3422d59a"
            }
        ],
        "pointGroups":[],
        "points":[
            {
                "deviceName":"MegEye-W4K-E7-test",
                "location":"",
                "pointName":"MegEye-W4K-E7-test",
                "pointUuid":"e0ccbd3bf5b6458daf67a461e1e77ad8",
                "pointZoneName":"tmh"
            }
        ],
        "uuid":"def48ec1511e4f728aa2da1b68f2fea7"
    },
    "msg":"成功"
}

1.3. 更新访客门禁权限布控

基础信息

路径: /v1/api/access/deploy/visitor/update

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 是 布控记录uuid
name string 是 布控权限名称，全局唯一
personGroupUuids array 是 人员组uuids
  |─ string
pointUuids array 否 门禁点uuids，按门禁点布控时必传
  |─ string
pointGroupUuids array 否 门禁点组uuids，按门禁点组布控时必传
  |─ string
scheduleUuid string 否 时间计划uuid,选填,默认全天时间计划

Body示例:

{
  "uuid": "def48ec1511e4f728aa2da1b68f2fea7",
  "name": "测试访客门禁布控",
  "personGroupUuids": [
    "b7e8182480b5482590d2828f3422d59a"
  ],
  "pointUuids": [
    "e0ccbd3bf5b6458daf67a461e1e77ad8"
  ]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.4. 分页查询

基础信息

路径: /v1/api/access/deploy/visitor/page

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
deployState integer 是 1 布控状态，1：成功；0：失败（默认1）
name string 否 权限名称，按权限名称查询
personGroupUuids array 否 人员组uuids，按人员组查询
  |─ string
pointUuids array 否 门禁点uuids，按门禁点查询
  |─ string
pointGroupUuids array 否 门禁点组uuids，按门禁点组查询
  |─ string
scheduleUuids array 否 长期时间计划uuids
  |─ string
pageNum integer 否 1 页码，从1开始
当前页码,不传默认1
pageSize integer 否 20 页面大小
分页大小，不传默认20

Body示例:

{
  "deployState": 1,
  "name": "测试",
  "pageNum": 1,
  "pageSize": 10
}

返回数据

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
      |─name string 否 布控权限名称
      |─personGroupNames array 否 人员组名称
        |─ string
      |─pointNames array 否 门禁点名称
        |─ string
      |─pointGroupNames array 否 门禁点组名称
        |─ string
      |─scheduleName string 否 时间计划名称
      |─failMsg string 否 布控失败原因 deployState = 0 时有值

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "failMsg":"",
                "name":"测试访客门禁布控",
                "personGroupNames":[
                    "test-visitor"
                ],
                "pointGroupNames":[
                    "-"
                ],
                "pointNames":[
                    "MegEye-W4K-E7-test"
                ],
                "scheduleName":"openapi默认访客全天时间计划",
                "uuid":"def48ec1511e4f728aa2da1b68f2fea7"
            }
        ],
        "pageNum":0,
        "pageSize":10,
        "total":1
    },
    "msg":"成功"
}

1.5. 删除门禁权限布控

基础信息

路径: /v1/api/access/deploy/visitor/delete

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuids array 是 门禁权限uuids
  |─ string

Body示例:

{
  "uuids": [
    "def48ec1511e4f728aa2da1b68f2fea7"
  ]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

results matching ""

    No results matching ""