1. 门禁点组管理

门禁点组管理

1.1. 门禁点组分页查询

基础信息

路径: /v1/api/access/group/page

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
name string 否 门禁点组名称
pageNum integer 否 1 页码，从1开始
当前页码,不传默认1
pageSize integer 否 20 页面大小
分页大小，不传默认20

Body示例:

{
  "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 否 门禁点组名称

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "name":"测试门禁点组2",
                "uuid":"fac371c9292242af86e4c499f22b91eb"
            }
        ],
        "pageNum":1,
        "pageSize":10,
        "total":1
    },
    "msg":"成功"
}

1.2. 创建门禁点组

基础信息

路径: /v1/api/access/group/add

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
name string 是 门禁点组名称，全局唯一

Body示例:

{
  "name": "测试门禁点组"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 否 门禁点组uuid
  |─name string 否 门禁点组名称，全局唯一

响应示例:

{
    "code":0,
    "data":{
        "name":"测试门禁点组",
        "uuid":"fac371c9292242af86e4c499f22b91eb"
    },
    "msg":"成功"
}

1.3. 修改门禁点组名字

基础信息

路径: /v1/api/access/group/update

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 是 门禁点组uuid
name string 是 门禁点组名称，全局唯一

Body示例:

{
  "uuid": "fac371c9292242af86e4c499f22b91eb",
  "name": "测试门禁点组2"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 否 门禁点组uuid
  |─name string 否 门禁点组名称，全局唯一

响应示例:

{
    "code":0,
    "data":{
        "name":"测试门禁点组2",
        "uuid":"fac371c9292242af86e4c499f22b91eb"
    },
    "msg":"成功"
}

1.4. 删除门禁点组

基础信息

路径: /v1/api/access/group/delete

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuids array 是 门禁点组uuid
  |─ string

Body示例:

{
  "uuids": [
    "fac371c9292242af86e4c499f22b91eb"
  ]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.5. 分页查询门禁点组中的门禁点列表

基础信息

路径: /v1/api/access/group/point/page

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pointName string 是 门禁点名称
groupUuid string 是 门禁点组uuid
pageNum integer 否 1 页码，从1开始
当前页码,不传默认1
pageSize integer 否 20 页面大小
分页大小，不传默认20

Body示例:

{
  "pointName": "test",
  "groupUuid": "fac371c9292242af86e4c499f22b91eb",
  "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
      |─pointUuid string 否 门禁点uuid
      |─pointName string 否 门禁点名称
      |─pointZoneName string 否 门禁点区域名称
      |─location string 否 门禁点位置
      |─deviceName string 否 所属设备

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "deviceName":"MegEye-W4K-E7-test",
                "location":"",
                "pointName":"MegEye-W4K-E7-test",
                "pointUuid":"e0ccbd3bf5b6458daf67a461e1e77ad8",
                "pointZoneName":"tmh"
            }
        ],
        "pageNum":1,
        "pageSize":10,
        "total":1
    },
    "msg":"成功"
}

1.6. 操作门禁点组中的门禁点

基础信息

路径: /v1/api/access/group/point/edit

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
groupUuid string 是 门禁点组uuid
pointUuids array 是 最终需要在门禁点组中保存门禁点uuid
  |─ string

Body示例:

{
  "groupUuid": "fac371c9292242af86e4c499f22b91eb",
  "pointUuids": [
    "e0ccbd3bf5b6458daf67a461e1e77ad8"
  ]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

1.7. 批量移除门禁点组中的门禁点

基础信息

路径: /v1/api/access/group/point/remove

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
groupUuid string 是 门禁点组uuid
pointUuids array 是 门禁点uuid列表
  |─ string

Body示例:

{
  "groupUuid": "fac371c9292242af86e4c499f22b91eb",
  "pointUuids": [
    "e0ccbd3bf5b6458daf67a461e1e77ad8"
  ]
}

返回数据

Headers:

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

Body:

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

响应示例:

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

results matching ""

    No results matching ""