1. 组管理

1.1. 批量添加组

基础信息

路径: /v1/api/pass/group/batchAdd

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
groupList array 是 人员组列表
  |─ object
    |─uuid string 否 人员组唯一标志uuid，长度1~40，不支持特殊字符
    |─name string 是 组名称，唯一，长度1~50，不支持特殊字符
    |─type integer 是 组类型, 1：员工组；2：访客组；3：关注人员组
    |─module integer 是 组类别， 1：通行，2：安防
    |─addPersonType integer 否 安防组添加人员方式，0：手动，1：自动，默认0

Body示例:

{
  "groupList":[
    {
      "uuid":"1111",
      "name":"11_11",
      "type":1
    },
    {
      "uuid":"1112",
      "name":"1112",
      "type":1
    }
  ]
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─successes array 是 成功列表
    |─ object
      |─uuid string 是 人员组唯一标志uuid
      |─name string 是 人员组名称
      |─type integer 是 1 基础人员组 2访客组 3 关注人员组
      |─module integer 否 安组类别， 1：通行，2：安防
      |─code integer 否 结果状态码
      |─msg string 否 结果信息提示
  |─failures array 是 失败列表
    |─ object
      |─uuid string 是 人员组唯一标志uuid
      |─name string 是 人员组名称
      |─type integer 是 1 基础人员组 2访客组 3 关注人员组
      |─module integer 否 组类别， 1：通行，2：安防
      |─code integer 否 结果状态码
      |─msg string 否 结果信息提示

响应示例:

{
  "code": 0,
  "data": {
    "failures": [],
    "successes": [
      {
        "isAll": 0,
        "name": "11_11",
        "type": 1,
        "uuid": "1111"
      },
      {
        "isAll": 0,
        "name": "1112",
        "type": 1,
        "uuid": "1112"
      }
    ]
  },
  "msg": "成功"
}

1.2. 删除组

基础信息

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

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
  "uuid":"1111"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否  

响应示例:

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

1.3. 修改组

基础信息

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

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 是 人员组唯一标志uuid
name string 是 组名称

Body示例:

{
  "uuid":"1112",
  "name":"asd"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否  

响应示例:

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

1.4. 查询组详情

基础信息

路径: /v1/api/pass/group/query

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
  "uuid":"1112"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─uuid string 是 uuid
  |─name string 是 组名
  |─type integer 是 组类型, 1：基础人员组；2：访客组；3：关注人员组
  |─personTotal integer 是 组内员工数
  |─defaultFlag integer 否 是否默认 0非默认 1默认（仅访客支持）

响应示例:

{
  "code": 0,
  "data": {
    "defaultFlag": 0,
    "isAll": 0,
    "name": "asd",
    "personTotal": 0,
    "type": 1,
    "uuid": "1112"
  },
  "msg": "成功"
}

1.5. 组列表

基础信息

路径: /v1/api/pass/group/list

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pageNum integer 否 1 分页页码，默认为 1
pageSize integer 否 20 分页大小，默认为 20
type integer 是 组类别：1-基础人员组； 2-访客组 ；3-关注人员组
module integer 否 1 模块：1-门禁组，默认； 2-安防组
name string 否 组名
containRemote boolean 否 false 是否查远程认证组，默认否

Body示例:

{
  "type":1
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─pageNum integer 是 当前页码
  |─pageSize integer 是 分页大小
  |─total integer 是 总数
  |─list array 否
    |─ object
      |─uuid string 是 组UUID
      |─name string 是 组名
      |─type integer 是 组类型, 1：基础人员组；2：访客组；3：关注人员组
      |─personTotal integer 是 总人数
      |─defaultFlag integer 否 是否默认 0非默认 1默认

响应示例:

{
  "code": 0,
  "data": {
    "list": [
      {
        "defaultFlag": 0,
        "isAll": 0,
        "name": "asd",
        "personTotal": 0,
        "type": 1,
        "uuid": "1112"
      }
    ],
    "pageNum": 1,
    "pageSize": 20,
    "total": 1
  },
  "msg": "成功"
}

1.6. 查询组内人员详情

基础信息

路径: /v1/api/pass/group/queryPersonListInGroup

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
pageNum integer 否 1 分页页码，默认为 1
pageSize integer 否 20 分页大小，默认为 20
uuid string 是 人员组唯一标志uuid
type integer 否 组类型, 1：基础人员组；2：访客组；3：关注人员组
name string 否 人员姓名
personCode string 否 人员编号

Body示例:

{
  "uuid":"23121432421342143124312421412444"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─pageNum integer 是 当前页码
  |─pageSize integer 是 分页大小
  |─total integer 是 总数
  |─list array 否
    |─ object
      |─groupUuid string 是 组uuid
      |─personUuid string 是 人员uuid
      |─imageUri string 否 用户影像
      |─personName string 是 人员名
      |─personCode string 否 员工编号(员工组)
      |─visitTargetUuid string 否 拜访用户uuid
      |─visitTarget string 否 拜访用户姓名
      |─visitStartTime string 否 拜访起始时间(时间戳)
      |─visitEndTime string 否 拜访结束时间(时间戳)
      |─status string 否 访客状态：无效、有效
      |─phone string 否 手机号码
      |─identifyNum string 否 身份证号码
      |─type integer 否 人员类型
      |─visitReason string 否 拜访原因, 访客可填,格式: 任意字符, 长度: 1-255

响应示例:

{
  "code": 0,
  "data": {
    "list": [
      {
        "groupUuid": "23121432421342143124312421412444",
        "personName": "FK008",
        "personUuid": "06381ea6f89a4792b4fbd19e4f600123",
        "phone": "85B5B9DB67DBC3D3F67EB10C17810CD4",
        "status": "有效",
        "type": 2,
        "visitEndTime": 1679068800000,
        "visitReason": "其他",
        "visitStartTime": 1678930693000
      },
      {
        "groupUuid": "23121432421342143124312421412444",
        "personName": "FK010",
        "personUuid": "aa9c22f13f01416ebcd2d3f950796d57",
        "phone": "275784B7A72623E04CBB0460AB674277",
        "status": "有效",
        "type": 2,
        "visitEndTime": 1679810297000,
        "visitReason": "",
        "visitStartTime": 1678948744000
      }
    ],
    "pageNum": 1,
    "pageSize": 20,
    "total": 2
  },
  "msg": "成功"
}

1.7. 编辑组内人员

基础信息

路径: /v1/api/pass/group/batchUpdatePerson

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
groupUuid string 是 人员组唯一标志uuid
personUuids array 是 人员uuid列表
  |─ string  

Body示例:

{
  "groupUuid":"1112",
  "personUuids":[
    "b50eebac3796445cb595f1a1af70074f",
    "a3d829033c4c4267ac126918c3ed4c1f"
  ]
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否  

响应示例:

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

1.8. 批量移除组内人员

基础信息

路径: /v1/api/pass/group/batchDeletePerson

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
groupUuid string 是 人员组唯一标志uuid
personUuids array 是 人员uuid列表
  |─ string  

Body示例:

{
  "groupUuid":"1112",
  "personUuids":[
    "b50eebac3796445cb595f1a1af70074f",
    "a3d829033c4c4267ac126918c3ed4c1f"
  ]
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否  

响应示例:

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

1.9. 组内增量更新人员

基础信息

路径: /v1/api/pass/group/updatePerson

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
groupUuid string 是 组uuid
delPersonList array 否 待删除人的uuid
  |─ string
addPersonList array 否 待添加人的uuid
  |─ string  

Body示例:

{
  "groupUuid": "1112",
  "addPersonList": [
    "b50eebac3796445cb595f1a1af70074f"
  ]
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─failPersons array 否 添加失败的人员信息
    |─ object
      |─uuid string 否 人员uuid
      |─reason string 否 失败原因

响应示例:

{
  "code": 0,
  "data": {
    "failPersons": []
  },
  "msg": "成功"
}

results matching ""

    No results matching ""