人员权限管理

更新时间:2022-12-13 05:49:01下载pdf

API 列表

请求方式 API 描述
POST /v1.0/iot-02/building/access-auth 查询人行综合权限列表
GET /v1.0/iot-02/building/access-auth/detail 查询人行综合权限详情
POST /v1.0/iot-02/building/access-auth-issue/actions/full 全量下发
POST /v1.0/iot-02/building/access-auth-issue/actions/increment 增量下发
POST /v1.0/iot-02/building/access-auth-task 查询下发记录(正在下发/下发完成)
GET /v1.0/iot-02/building/access-auth-task/{authTaskId} 查询下发记录详情
POST /v1.0/iot-02/building/access-auth-task/records 查询任务明细列表
GET /v1.0/iot-02/building/access-auth-task/actions/issue-info 查询下发记录明细详情

查询人行综合权限

功能描述

人行综合权限列表查询。

接口地址

POST /v1.0/iot-02/building/access-auth

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
name String body 姓名
sex Integer body 性别
mobile String body 手机号
structureId String body 所属组织 ID
personCode String body 工号
authDateType Integer body 权限有效期:
  • 0:全部,一直有效
  • -1:过期
  • 7:小于 7 天
  • 15:小于 15 天
  • 30:小于 30 天
accessControlChannelName String body 出入口名称
accessChannelRoomId String body 出入口安装空间 ID
businessDeviceName String body 门禁设备
authStartTime long body 权限生成开始时间
authEndTime long body 权限生成截止时间
faceIssueStatus Integer body 人脸下发状态。是否成功:
  • 1:已下发
  • 0:待下发
cardIssueStatus Integer body 卡号下发状态。是否成功:
  • 1:已下发
  • 0:待下发
fingerprintIssueStatus Integer body 指纹下发状态。是否成功:
  • 1:已下发
  • 0:待下发
page Integer body 页数
pageSize Integer body 页大小
channelIds String[] body 出入口 ID 集,批量查询出入口相关的权限集

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "accessAuthId": "String //授权 ID",
      "personId": "String //人员 ID",
      "name": "String //姓名",
      "sex": "String //性别",
      "mobileCountry": "String //手机码",
      "mobile": "String //手机号",
      "personCode": "String //工号",
      "structureIds": "String[] //组织关系 ID",
      "accessAuthTimeRangeId": "String //通行时间段 ID:目前默认全天周",
      "accessAuthTimeRangeStr": "String //通行时间段数值:目前默认全天周",
      "businessDeviceName": "String //业务设备名称",
      "accessControlChannelId": "String //出入口 ID",
      "authStartTime": "long //权限起始时间",
      "authEndTime": "long //权限截止时间",
      "accessControlChannelName": "String //出入口名称",
      "accessControlChannelNo": "String //出入口通道号",
      "accessChannelRoomId": "String //出入口安装空间 ID",
      "accessChannelPositionPath": "String //出入口安装空间名称",
      "totalCardNum": "int //总卡数",
      "authCardNum": "int //下发的卡数",
      "totalFaceNum": "int //总人脸数",
      "authFaceNum": "int //下发的人脸数",
      "totalFingerprintNum": "int //总指纹数",
      "authFingerprintNum": "int //下发的指纹数",
      "faceIssueStatus": "int //人脸下发状态,0:待下发,1:已下发",
      "cardIssueStatus": "int //卡号下发状态,0:待下发,1:已下发",
      "fingerprintIssueStatus": "int //指纹下发状态,0:待下发,1:已下发"
    }
  ],
  "hasMore": "boolean"
}

请求示例

{
  "authEndTime": "权限生成截止时间",
  "sex": "性别",
  "accessChannelRoomId": "出入口安装空间 ID",
  "businessDeviceName": "门禁设备",
  "mobile": "手机号",
  "structureId": "所属组织 ID",
  "pageSize": "页大小",
  "personCode": "工号",
  "authDateType": "权限有效期,0:全部,-1:过期,7:小于 7 天,15:小于 15 天,30:小于 30 天",
  "accessControlChannelName": "出入口名称",
  "authStartTime": "权限生成开始时间",
  "faceIssueStatus": "人脸下发状态,0:待下发,1:已下发",
  "name": "姓名",
  "fingerprintIssueStatus": "指纹下发状态,0:待下发,1:已下发",
  "page": "页数",
  "channelIds": "出入口 ID 集:批量查询出入口相关的权限集",
  "projectId": "项目 ID",
  "cardIssueStatus": "卡号下发状态,0:待下发,1:已下发"
}

响应示例

{
    "result": {
        "list": [
            {
                "access_auth_id": "1567699430642122***",
                "access_auth_time_range_id": "1",
                "access_auth_time_range_str": "全天周",
                "access_channel_position_path": "中心-11",
                "access_channel_room_id": "1424637349790294***",
                "access_control_channel_id": "1551450935983616***",
                "access_control_channel_name": "虚拟宿舍 102",
                "access_control_channel_no": 1,
                "auth_card_num": 4,
                "auth_end_time": 2556115199000,
                "auth_face_num": 0,
                "auth_start_time": 1662566400000,
                "business_device_name": "虚拟设备",
                "card_issue_status": 1,
                "face_issue_status": 0,
                "fingerprint_issue_status": 0,
                "mobile": "182****2940",
                "mobile_country": "+86",
                "name": "测试",
                "person_code": "090909",
                "person_id": "1532183396648747***",
                "sex": "1",
                "structure_ids": [
                    "1531473126917959***"
                ],
                "total_card_num": 3,
                "total_face_num": 1
            },
            {
                "access_auth_id": "1567428255730958***",
                "access_auth_time_range_id": "1",
                "access_auth_time_range_str": "全天周",
                "access_channel_position_path": "中心-11",
                "access_channel_room_id": "1424637349790294***",
                "access_control_channel_id": "1551450935983616***",
                "access_control_channel_name": "虚拟宿舍 102",
                "access_control_channel_no": 1,
                "auth_card_num": 1,
                "auth_end_time": 2556115199000,
                "auth_face_num": 0,
                "auth_start_time": 1662048000000,
                "business_device_name": "虚拟设备",
                "card_issue_status": 1,
                "face_issue_status": 0,
                "fingerprint_issue_status": 0,
                "mobile": "199****9879",
                "mobile_country": "+86",
                "name": "newpeople",
                "person_code": "456",
                "person_id": "1567428253323362***",
                "sex": "1",
                "structure_ids": [
                    "1466612511766855***"
                ],
                "total_card_num": 1,
                "total_face_num": 1
            },
            {
                "access_auth_id": "1564884950136676***",
                "access_auth_time_range_id": "1",
                "access_auth_time_range_str": "全天周",
                "access_channel_position_path": "中心-11",
                "access_channel_room_id": "1424637349790294***",
                "access_control_channel_id": "1551450935983616***",
                "access_control_channel_name": "虚拟宿舍 102",
                "access_control_channel_no": 1,
                "auth_card_num": 1,
                "auth_end_time": 2556115199000,
                "auth_face_num": 0,
                "auth_start_time": 1662048000000,
                "business_device_name": "虚拟设备",
                "card_issue_status": 1,
                "face_issue_status": 0,
                "fingerprint_issue_status": 0,
                "mobile": "188****9898",
                "mobile_country": "+86",
                "name": "张三",
                "person_code": "1123",
                "person_id": "1564855972651077***",
                "sex": "1",
                "structure_ids": [
                    "1466612511766855***"
                ],
                "total_card_num": 1,
                "total_face_num": 1
            }
        ],
        "total": 7
    },
    "success": true,
    "t": 1664188226266,
    "tid": "3bce60c83d8611ed84fd2237f0528b74"
}

查询人行综合权限详情

功能描述

查询人行综合权限详情。

接口地址

GET /v1.0/iot-02/building/access-auth/detail

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessAuthId String body 授权 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "personId": "String //人员 ID",
  "name": "String //姓名",
  "imageUrl": "String //人员照片",
  "sex": "int //性别 code",
  "sexStr": "String //性别值",
  "mobileCountry": "String //手机码",
  "mobile": "String //手机号",
  "personCode": "String //工号",
  "structureNames": "String[] //组织名称",
  "accessControlChannelName": "String //出入口名称",
  "accessControlChannelNo": "String //出入口通道号",
  "accessChannelRoomId": "String //出入口安装空间 ID",
  "accessChannelPositionPath": "String //出入口安装位置",
  "businessDeviceName": "String //门禁设备",
  "authStartTime": "long //权限开始时间",
  "authEndTime": "long //权限截止时间",
  "authCreateTime": "long //权限生成时间",
  "authSource": "String //授权来源",
  "authSourceStr": "String //授权来源名称",
  "totalCardNum": "int //总卡数",
  "authCardNum": "int //下发的卡数",
  "totalFaceNum": "int //总人脸数",
  "authFaceNum": "int //下发的人脸数",
  "totalFingerprintNum": "int //总指纹数",
  "authFingerprintNum": "int //下发的指纹数",
  "faceIssueStatus": "int //人脸下发状态,0:待下发,1:已下发",
  "cardIssueStatus": "int //卡号下发状态,0:待下发,1:已下发",
  "fingerprintIssueStatus": "int //指纹下发状态,0:待下发,1:已下发"
}

请求示例

{
  "accessAuthId": "授权 ID",
  "projectId": "项目 ID"
}

响应示例

{
  "personId": "人员 ID",
  "name": "姓名",
  "imageUrl": "人员照片",
  "sex": "性别 code",
  "sexStr": "性别值",
  "mobileCountry": "手机码",
  "mobile": "手机号",
  "personCode": "工号",
  "structureNames": "组织名称",
  "accessControlChannelName": "出入口名称",
  "accessControlChannelNo": "出入口通道号",
  "accessChannelRoomId": "出入口安装空间 ID",
  "accessChannelPositionPath": "出入口安装位置",
  "businessDeviceName": "门禁设备",
  "authStartTime": "权限开始时间",
  "authEndTime": "权限截止时间",
  "authCreateTime": "权限生成时间",
  "authSource": "授权来源",
  "authSourceStr": "授权来源名称",
  "totalCardNum": "总卡数",
  "authCardNum": "下发的卡数",
  "totalFaceNum": "总人脸数",
  "authFaceNum": "下发的人脸数",
  "totalFingerprintNum": "总指纹数",
  "authFingerprintNum": "下发的指纹数",
  "faceIssueStatus": "人脸下发状态,0:待下发,1:已下发",
  "cardIssueStatus": "卡号下发状态,0:待下发,1:已下发",
  "fingerprintIssueStatus": "指纹下发状态,0:待下发,1:已下发"
}

全量下发

功能描述

全量下发。

接口地址

POST /v1.0/iot-02/building/access-auth-issue/actions/full

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
authIssueCertificate Integer body
  • 1:卡
  • 2:卡+人脸
  • 3:卡+通行密码
  • 4:卡+通行密码+人脸
channelIds String[] body 出入口 ID 集

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

String{}

请求示例

{
  "channelIds": "出入口 ID 集",
  "projectId": "项目 ID",
  "authIssueCertificate": "@link com.tuya.lingshu.service.accesscontrol.issue.enums.AuthIssueCertPolicyEnum"
}

响应示例

String{}

增量下发

功能描述

增量下发。

接口地址

POST /v1.0/iot-02/building/access-auth-issue/actions/increment

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
authIssueCertificate Integer body
  • 1:卡
  • 2:卡+人脸
  • 3:卡+通行密码
  • 4:卡+通行密码+人脸
channelIds String[] body 出入口 ID 集

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

String{}

请求示例

{
  "channelIds": "出入口 ID 集",
  "projectId": "项目 ID",
  "authIssueCertificate": "@link com.tuya.lingshu.service.accesscontrol.issue.enums.AuthIssueCertPolicyEnum"
}

响应示例

String{}

查询下发记录

功能描述

查询下发记录,包括正在下发和下发完成。

接口地址

POST /v1.0/iot-02/building/access-auth-task

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
issueType Integer body 查询类型:
  • 1:正在下发
  • 2:下发完成
taskStartStartTime long body 搜索开始时间的开始时间
taskStartEndTime long body 搜索开始时间的结束时间
accessControlChannelName String body 出入口名称
accessChannelPositionPath String body 出入口安装位置
businessDeviceName String body 门禁设备
authNumType Integer body 权限数:
  • -1:全部
  • 0:无
  • 1:有
authIssueType Integer body 下发方式:
  • 1:全量下发
  • 2:增量下发
authIssueCertificate Integer body 通行凭证:
  • 1:卡
  • 2:卡+人脸
  • 3:卡+指纹
authTaskProgress Integer body 任务进度:
  • 0:初始化
  • 1:完成
  • 2:终止
  • 3: 执行中
authTaskStatus Integer body 任务下发结果:
  • 1:全部成功
  • 2:部分成功
  • 3:全部失败
  • 4:终止
taskFinishStartTime long body 搜索完成时间的开始时间
taskFinishEndTime long body 搜索完成时间的结束时间
page Integer body 页数
pageSize Integer body 页大小

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "authTaskId": "String //任务 ID",
      "taskStartTime": "long //开始时间",
      "accessControlChannelName": "String //出入口名称",
      "accessControlChannelNo": "String //出入口通道号",
      "accessChannelPositionPath": "String //出入口安装位置",
      "businessDeviceName": "String //门禁设备",
      "authNum": "int //权限数",
      "authIssueType": "int //下发方式,全量下发:1,增量下发:2",
      "successNum": "int //下发成功数量",
      "authTaskProgress": "int //任务进度,初始化:0,未开始:1,执行中:2,中途终止:3,完成:4",
      "authTaskStatus": "int //任务下发结果,未开始:0,部分成功:1,全部成功:2,全部失败:3,终止:4",
      "taskFinishTime": "long //结束时间"
    }
  ],
  "hasMore": "boolean"
}

请求示例

{
  "taskStartStartTime": "搜索开始时间的开始时间",
  "authTaskProgress": "任务进度,初始化:0,完成:1,终止:2,执行中:3",
  "businessDeviceName": "门禁设备",
  "authIssueType": "下发方式,全量下发:1,增量下发:2",
  "pageSize": "页大小",
  "accessChannelPositionPath": "出入口安装位置",
  "taskFinishEndTime": "搜索完成时间的结束时间",
  "taskFinishStartTime": "搜索完成时间的开始时间",
  "issueType": "查询类型:1: 正在下发,2: 下发完成",
  "accessControlChannelName": "出入口名称",
  "authTaskStatus": "任务下发结果,全部成功:1,部分成功:2,全部失败:3,终止:4",
  "authNumType": "权限数,-1: 全部,0: 无,1: 有",
  "taskStartEndTime": "搜索开始时间的结束时间",
  "page": "页数",
  "projectId": "项目 ID",
  "authIssueCertificate": "通行凭证,卡:1,卡+人脸:2,卡+指纹:3"
}

响应示例

{
  "total": "int",
  "list": [
    {
      "list": "结束时间"
    }
  ],
  "hasMore": "boolean"
}

查询下发记录详情

功能描述

查询下发记录详情。

接口地址

GET /v1.0/iot-02/building/access-auth-task/{authTaskId}

请求参数

参数名 类型 参数类型 说明 是否必需
authTaskId String url 任务 ID
projectId String body 项目 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "taskStartTime": "long //任务开始时间",
  "taskFinishTime": "long //任务结束时间",
  "authIssueCertificate": "int //通行凭证,卡:1,卡+人脸:2,卡+指纹:3",
  "authIssueCertificateStr": "String //通行凭证名称,卡:1,卡+人脸:2,卡+指纹:3",
  "accessControlChannelName": "String //出入口名称",
  "accessControlChannelNo": "String //出入口通道号",
  "accessChannelPositionPath": "String //出入口安装位置",
  "businessDeviceName": "String //门禁设备"
}

请求示例

{
  "authTaskId": "任务 ID",
  "projectId": "项目 ID"
}

响应示例

{
  "taskStartTime": "任务开始时间",
  "taskFinishTime": "任务结束时间",
  "authIssueCertificate": "通行凭证,卡:1,卡+人脸:2,卡+指纹:3",
  "authIssueCertificateStr": "通行凭证名称,卡:1,卡+人脸:2,卡+指纹:3",
  "accessControlChannelName": "出入口名称",
  "accessControlChannelNo": "出入口通道号",
  "accessChannelPositionPath": "出入口安装位置",
  "businessDeviceName": "门禁设备"
}

任务明细列表

功能描述

任务明细列表。

接口地址

POST /v1.0/iot-02/building/access-auth-task/records

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
authTaskId String body 任务授权任务 ID
name String body 姓名
mobile String body 手机号
structureName String body 所属组织
issueStatus Integer body 下发结果:
  • 0:初始化
  • 1:未知
  • 2:终止
  • 3:失败
  • 4:成功
page Integer body 页数
pageSize Integer body 页大小

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "totalNum": "int //总任务明细数量",
  "successNum": "int //成功下发数量",
  "recordListVOList": {
    "total": "int",
    "list": [
      {
        "projectId": "String //项目 ID",
        "authTaskRecordId": "String //任务明细 ID",
        "personId": "String //人员 ID",
        "name": "String //姓名",
        "mobileCountry": "String //手机码",
        "mobile": "String //手机号",
        "structureName": "String //所属组织",
        "accessAuthTimeRangeId": "String //通行时间段:目前默认全天周",
        "accessAuthTimeRangeStr": "String //通行时间段:目前默认全天周",
        "authIssueTime": "long //下发时间",
        "issueStatus": "int //初始化:0,未知:1,终止:2,失败:3,成功:4"
      }
    ],
    "hasMore": "boolean"
  }
}

请求示例

{
  "issueStatus": "下发结果,初始化:0,未知:1,终止:2,失败:3,成功:4",
  "authTaskId": "任务授权任务 ID",
  "structureName": "所属组织",
  "name": "姓名",
  "mobile": "手机号",
  "pageSize": "页大小",
  "page": "页数",
  "projectId": "项目 ID"
}

响应示例

{
  "totalNum": "总任务明细数量",
  "successNum": "成功下发数量",
  "recordListVOList": {
    "recordListVOList": "boolean",
    "list": [
      {
        "list": "初始化:0,未知:1,终止:2,失败:3,成功:4"
      }
    ]
  }
}

查询下发记录明细详情

功能描述

查询下发记录明细详情。

接口地址

GET /v1.0/iot-02/building/access-auth-task/actions/issue-info

请求参数

参数名 类型 参数类型 说明 是否必需
authTaskRecordId String body 任务 ID
projectId String body 项目 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功.true:成功,false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "projectId": "String //项目 ID",
  "authTaskRecordId": "String //任务明细 ID",
  "personIssueResult": {
    "successIssueNum": "int //下发成功数量",
    "failIssueNum": "int //下发失败数量",
    "successIssueDelNum": "int //删除成功数量",
    "failIssueDelNum": "int //删除失败数量"
  },
  "cardIssueResult": {
    "successIssueNum": "int //下发成功数量",
    "failIssueNum": "int //下发失败数量",
    "successIssueDelNum": "int //删除成功数量",
    "failIssueDelNum": "int //删除失败数量"
  },
  "cardPwdIssueResult": {
    "successIssueNum": "int //下发成功数量",
    "failIssueNum": "int //下发失败数量",
    "successIssueDelNum": "int //删除成功数量",
    "failIssueDelNum": "int //删除失败数量"
  },
  "faceIssueResult": {
    "successIssueNum": "int //下发成功数量",
    "failIssueNum": "int //下发失败数量",
    "successIssueDelNum": "int //删除成功数量",
    "failIssueDelNum": "int //删除失败数量"
  },
  "fingerprintIssueResult": {
    "successIssueNum": "int //下发成功数量",
    "failIssueNum": "int //下发失败数量",
    "successIssueDelNum": "int //删除成功数量",
    "failIssueDelNum": "int //删除失败数量"
  }
}

请求示例

{
  "projectId": "项目 ID",
  "authTaskRecordId": "任务 ID"
}

响应示例

{
  "projectId": "项目 ID",
  "authTaskRecordId": "任务明细 ID",
  "personIssueResult": {
    "personIssueResult": "删除失败数量"
  },
  "cardIssueResult": {
    "cardIssueResult": "删除失败数量"
  },
  "cardPwdIssueResult": {
    "cardPwdIssueResult": "删除失败数量"
  },
  "faceIssueResult": {
    "faceIssueResult": "删除失败数量"
  },
  "fingerprintIssueResult": {
    "fingerprintIssueResult": "删除失败数量"
  }
}

错误码

以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

错误码 说明
500 系统错误