简体中文
简体中文
English
联系我们
注册
登录

人员持卡管理

更新时间:2023-01-12 07:14:45下载pdf

人员持卡管理

请求方式 API 描述
GET /v1.0/iot-02/building/personnel-cards 获取人员持卡列表
GET /v1.0/iot-02/building/personnel-cards/actions/hold-cards 获取人员持卡详情
GET /v1.0/iot-02/building/personnel-cards/actions/personnel-detail 获取人员基本信息
PUT /v1.0/iot-02/building/personnel-cards/actions/edit-password 编辑卡密码

获取人员持卡列表

功能描述

获取人员持卡列表。

接口地址

GET /v1.0/iot-02/building/personnel-cards

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
structureId String body 组织 ID false
searchType int body 查询类型。
1:只查询 structureId 下直接关联人员
2: 查询 structureId 关联及所有下级组织人员(默认)
false
name String body 姓名 false
enabled int body 是否启用。
1:启用(默认 1)
2: 禁用
false
sex int body 性别 false
mobile String body 手机号 false
feature String body 生物特征 false
holdCard String body 是否持有卡片。
0:无
1:有
false
containPassword int body 是否有卡密码。
0:无
1:有
false
page int body 当前页 false
pageSize int body 每页数 false
cardStatus int body 卡状态。
1:正常
2:冻结
false
cardNo String body 卡号 false
personId String body 人员 ID false
cardType int body 卡类型。
1:实体卡
2:虚拟卡
false

返回参数

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

result 参数说明

{
  "total": "int",
  "list": [
    {
      "personId": "String //人员 ID",
      "name": "String //姓名",
      "enabled": "int //是否启用",
      "sex": "int //性别 code",
      "sexStr": "String //性别值",
      "certArea": "String //证件号区域",
      "mobileCountry": "String //手机码",
      "mobile": "String //手机号",
      "feature": "String //生物特征",
      "imagePath": "String //图片路径",
      "structureIds": "String[] //组织关系 ID",
      "structureNames": "String[] //组织名称",
      "holdCardNum": "int //持卡数量",
      "containPassword": "int //是否有卡密码"
    }
  ]
}

请求示例

{
  "searchType": "查询类型,1-只查询 structureId 下直接关联人员,2-查询 structureId 关联及所有下级组织人员(默认)",
  "sex": "性别",
  "mobile": "手机号",
  "cardType": "卡类型,1-实体卡,2-虚拟卡",
  "structureId": "组织ID",
  "pageSize": "每页数",
  "containPassword": "是否有卡密码,0-无,1-有",
  "cardNo": "卡号",
  "enabled": "是否启用,1-启用(默认 1),2-禁用",
  "feature": "生物特征",
  "holdCard": "是否持有卡片,0-无,1-有",
  "name": "姓名",
  "personId": "人员 ID",
  "page": "当前页",
  "projectId": "项目 ID",
  "cardStatus": "卡状态,1-正常,2-冻结"
}

响应示例

{
    "result": {
        "list": [
            {
                "cert_area": "CN",
                "contain_password": 0,
                "enabled": 1,
                "hold_card_num": 2,
                "image_path": "saas/building/building_faceImg/1663644590a79c781cde7.jpg",
                "mobile": "421****1242",
                "mobile_country": "+86",
                "name": "13541",
                "person_id": "1572065489755312***",
                "sex": 1,
                "sex_str": "男",
                "structure_ids": [
                    "1439128101413011***"
                ],
                "structure_names": [
                    "根组织66678"
                ]
            }
        ],
        "total": 103
    },
    "success": true,
    "t": 1664188109402,
    "tid": "f65bb75a3d8511ed84fd2237f0528b74"
}

获取人员持卡详情

功能描述

获取人员持卡详情。

接口地址

GET /v1.0/iot-02/building/personnel-cards/actions/hold-cards

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
personId String body 人员 ID true
cardStatus int body 卡片状态。
1:正常
2:冻结
false
cardNo String body 卡号(精确查询) true

返回参数

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

result 参数说明

{
  "allNum": "int //持有卡片数",
  "freezeNum": "int //持有冻结卡片数",
  "normalNum": "int //持有正常卡片数",
  "cardList": [
    {
      "name": "String //姓名",
      "personCardId": "String //人员卡 ID",
      "cardNo": "String //卡号",
      "projectId": "String //项目编号",
      "personId": "String //人员 ID",
      "cardType": "int //卡类型:1-实体卡,2-虚拟卡",
      "cardStatus": "int //卡状态:1-正常,2-冻结",
      "bindFace": "int //绑定人脸:0-未绑定,1-绑定",
      "activationTime": "long //开卡时间",
      "reportLostTime": "long //挂失时间",
      "cancelReportLostTime": "long //解除挂失时间",
      "containPassword": "int //是否有卡密码",
      "structureNames": "String[] //组织名称",
      "mobileCountry": "String //手机码",
      "mobile": "String //手机号",
      "canBindFace": "boolean //是否可以绑定人脸"
    }
  ]
}

请求示例

{
  "personId": "人员 ID",
  "projectId": "项目 ID",
  "cardNo": "卡号(精确查询)",
  "cardStatus": "卡片状态      @see com.tuya.lingshu.biz.personcard.enums.PersonCardStatusEnum"
}

响应示例

{
    "result": {
        "all_num": 2,
        "card_list": [
            {
                "activation_time": 1662544806542,
                "bind_face": 1,
                "cancel_report_lost_time": 1662546245334,
                "card_no": "45454567",
                "card_status": 1,
                "card_type": 1,
                "contain_password": 1,
                "person_card_id": "1567452642714648***",
                "person_id": "1567428253323362***",
                "project_id": "1424615984265764***",
                "report_lost_time": 1662546168253
            },
            {
                "activation_time": 1662542164834,
                "bind_face": 0,
                "card_no": "232232232",
                "card_status": 2,
                "card_type": 1,
                "contain_password": 1,
                "person_card_id": "1567441562588217***",
                "person_id": "1567428253323362***",
                "project_id": "1424615984265764***",
                "report_lost_time": 1662544087744
            }
        ],
        "freeze_num": 1,
        "normal_num": 1
    },
    "success": true,
    "t": 1664188173781,
    "tid": "1cceff353d8611ed84fd2237f0528b74"
}

获取人员基本信息

功能描述

获取人员基本信息。

接口地址

GET /v1.0/iot-02/building/personnel-cards/actions/personnel-detail

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
personId String body 人员 ID true

返回参数

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

result 参数说明

{
  "personId": "String //人员 ID",
  "name": "String //姓名",
  "mobileCountry": "String //手机码",
  "mobile": "String //手机号",
  "imageUrl": "String //头像 URL 地址",
  "imagePath": "String //图片路径",
  "structureNames": "String[] //组织名称",
  "containPassword": "int //是否有卡密码"
}

请求示例

{
  "personId": "人员 ID",
  "projectId": "项目 ID"
}

响应示例

{
  "personId": "人员 ID",
  "name": "姓名",
  "mobileCountry": "手机码",
  "mobile": "手机号",
  "imageUrl": "头像 URL 地址",
  "imagePath": "图片路径",
  "structureNames": "组织名称",
  "containPassword": "是否有卡密码"
}

编辑卡密码

功能描述

编辑卡密码。

接口地址

PUT /v1.0/iot-02/building/personnel-cards/actions/edit-password

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
personId String body 人员 ID true
clearPassword boolean body 是否清除密码 true
encryptPassword String body 加密密码 true

返回参数

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

result 参数说明

boolean{}

请求示例

{
  "clearPassword": "是否清除密码",
  "encryptPassword": "加密密码",
  "personId": "人员 ID",
  "projectId": "项目 ID"
}

响应示例

boolean{}

错误码

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

错误码 说明
500 系统错误