1.4.3.1. 人员信息同步

人员基本信息同步接口请求,该接口包含人员信息的新增和修改。

Request:

POST /v1.0/hr/employee/sync
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956",
            "formattedName": "huiwu.lin",
            "lastUpdateTimeStamp": 1557910639,
            "devicePermission": "0",
            "devicePassword": "",
            "cardNo": "",
            "idCard": "3502xxxxxxx",
            "cardType": "1",
            "temporaryStatus": "0",
            "allowStatus": "0",
            "startTime": "2020-02-22T14:10:00+08:00",
            "endTime": "2020-02-22T14:20:00+08:00",
            "gender": "1",
            "email": "luther.lin@zkteco.com",
            "phone": "",
            "hireDate": "2019-06-03"
        }
    }
}
参数名 类型 必填 描述
employeeNo String Y 人员编号，企业内唯一；只能数字和字母组成，访客模式下，支持人员编号和人员身份证号
formattedName String Y 格式化后的姓名，用于显示，长度不超过64，建议越短越好，设备上显示长度有限，过长将显示不全
lastUpdateTimeStamp Long Y 第三方最后修改时间戳，若该时间戳小于或等于上一次该组织架构接收到的时间戳，则该数据不处理，但会返回成功编码
devicePermission String N 人员在设备的权限，0:普通人员(默认), 14:管理员
devicePassword String N 人员设备密码，若不开启人员密码打卡，建议当人员是管理员时才设置人员设备密码
cardNo String N 设备识别的用户卡号
idCard String N 个人身份证号或者身份证物理卡号，注：人员临时状态为【是】时，必填
cardType String N 证件类型. (1 - 身份证(默认)，2 - 外国人永居证，3 - 港澳台居民居住证)
temporaryStatus String N 人员临时状态.(0 - 否，1 - 是)，默认为空
allowStatus String N 人员允许状态.(1 - 允许名单，0 - 禁止名单)，默认为空
startTime String N 人员允许名单有效期开始时间, ISO标准时间格式:yyyy-MM-ddTHH:mm:ss±HH:mm, (yyyy-MM-ddTHH:mm:ss):服务端的本地时间, (±HH:mm):服务端的时区
endTime String N 人员允许名单有效期结束时间, ISO标准时间格式:yyyy-MM-ddTHH:mm:ss±HH:mm, (yyyy-MM-ddTHH:mm:ss):服务端的本地时间, (±HH:mm):服务端的时区
gender String N 性别, 1代表男性，2代表女性，3代表其他
email String N 邮箱地址
phone String N 联系电话、手机号码
hireDate String N 雇佣(入职)日期

注意事项：

  1. 本接口对非必填的属性，仅需要传入需要改动的属性，当不包含某个属性key值时，表示此属性不变动。 比如，只修改了该人员基础信息，设备信息、卡号等都不变，则入参为
    {
 "lang": "zh-cn",
 "usr": "username",
 "pwd": "password",
 "payload": {
     "params": {
         "employeeNo": "2956",
         "formattedName": "huiwu.lin",
         "gender": "1",
         "email": "luther.lin@zkteco.com",
         "phone": "",
         "hireDate": "2019-06-03",
         "lastUpdateTimeStamp": 1557910639
     }
 }
}

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success"
}

1.4.3.2. 人员信息同步(批量)

Request:

POST /v1.0/hr/employees/sync
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employees": [{
                "employeeNo": "2956",
                "formattedName": "huiwu.lin",
                "lastUpdateTimeStamp": 1557910639,
                "devicePermission": "0",
                "devicePassword": "",
                "cardNo": "",
                "idCard": "3502xxxxxxx",
                "cardType": "1",
                "temporaryStatus": "0",
                "allowStatus": "0",
                "startTime": "2020-02-22T14:10:00+08:00",
                "endTime": "2020-02-22T14:20:00+08:00",
                "gender": "1",
                "email": "luther.lin@zkteco.com",
                "phone": "",
                "hireDate": "2019-06-03"
            }]
        }
    }
}
参数名 类型 必填 描述
employees Object[] Y 人员列表，列表长度最大100

其他相关参数描述及注意事项参考人员信息同步

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "results": [{
            "employeeNo": "2956",
            "code": "00000000",
            "message": "success"
        }]
    }
}

1.4.3.3. 删除人员信息

第三方调用接口删除人员信息，系统会自动将此人员从关联的设备中移除。

Request:

POST /v1.0/hr/employee/delete
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "人员编号",
            "lastUpdateTimeStamp": 1557910639
        }
    }
}
参数名 类型 必填 描述
employeeNo String Y 人员编号
lastUpdateTimeStamp Integer Y 第三方最后修改时间戳，若该时间戳小于或等于上一次该人员收到的时间戳，则该数据不处理，但会返回成功编码

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success"
}

1.4.3.4. 删除人员信息(批量)

第三方调用接口删除人员信息，系统会自动将此人员从关联的设备中移除。

Request:

POST /v1.0/hr/employees/delete
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employees": [{
                "employeeNo": "人员编号",
                "lastUpdateTimeStamp": 1557910639
            }]
        }
    }
}
参数名 类型 必填 描述
employees Object[] Y 人员列表，列表长度最大100

其他相关参数描述及注意事项参考删除人员信息

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "results": [{
            "employeeNo": "人员编号",
            "code": "执行结果编码",
            "message": "执行结果描述"
        }]
    }
}

1.4.3.5. 人脸照片同步

人脸比对照片同步，此照片用于提取用户人脸生物识别模板,上传到dbs，并下发到该人员所绑定的设备，以便使用人脸打卡

Request:

POST /v1.0/hr/employee/face/sync
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956",
            "facePhoto": "http://test.com/2956.jpg"
        }
    }
}
参数名 类型 必填 描述
employeeNo String Y 人员编号
facePhoto String Y 人脸照片，用于人脸比对，支持URL(http/https)和base64，只支持jpg格式照片

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success"
}

1.4.3.6. 查询人员核验信息

查询人员在dbs系统中拥有的核验信息

Request:

POST /v1.0/hr/employee/verifyInfo/query
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956"
        }
    }
}
参数名 类型 必填 描述
employeeNo String Y 人员编号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success",
    "payload": {
        "results": {
            "facePhotoCount": 0,
            "fingerCount": 1,
            "faceCount": 0,
            "palmPrintCount": 0,
            "devicePermission": "14",
            "cardNo": "421343",
            "devicePassword": "41341",
            "deviceVerifyMode": "0"
        }
    }
}
参数名 类型 描述
facePhotoCount Integer 可见光人脸数
fingerCount Integer 指纹数
faceCount Integer 面部（近红外人脸）数
palmPrintCount Integer 掌纹数
devicePermission String 人员在设备的权限，0:普通人员(默认), 14:管理员
cardNo String 卡号
devicePassword String 人员设备密码
deviceVerifyMode String 验证方式，详见验证方式说明

1.4.3.7. 查询人员所在设备的核验信息

查询人员在不同设备上的核验信息

Request:

POST /v1.0/hr/employee/verifyInfo/queryByEmployee
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "curPage": 1,
        "pageSize": 10,
        "params": {
            "employeeNo": "2956",
            "sn": "1314"
        }
    }
}
参数名 类型 必填 描述
curPage Integer N 分页查询条件，分页页码，默认第1页
pageSize Integer N 分页查询条件，分页大小，默认每页10条，不超过20条
employeeNo String Y 人员编号
sn String N 设备序列号,当sn为空则查询该人员在所有已绑定设备的核验信息

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success",
    "payload": {
      "totalRecords": 4,
      "curPage": 1,
      "totalPages": 1,
      "pageSize": 10,
        "results": [{
            "sn": "134415",
            "facePhotoCount": 0,
            "fingerCount": 1,
            "faceCount": 0,
            "palmPrintCount": 0,
            "devicePermission": "14",
            "cardNo": "421343",
            "devicePassword": "41341",
            "deviceVerifyMode": "0"
        }]
    }
}
参数名 类型 描述
curPage Integer 分页页码
pageSize Integer 分页大小
totalRecords Integer 总记录数
totalPages Integer 总条数
sn String 设备序列号
facePhotoCount Integer 可见光人脸数
fingerCount Integer 指纹数
faceCount Integer 面部（近红外人脸）数
palmPrintCount Integer 掌纹数
devicePermission String 人员在设备的权限，0:普通人员(默认), 14:管理员
cardNo String 卡号
devicePassword String 人员设备密码
deviceVerifyMode String 验证方式，详见验证方式说明

1.4.3.8. 查询设备上的人员核验信息

查询设备上不同人员的核验信息

Request:

POST /v1.0/hr/employee/verifyInfo/queryVerifyBySn
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
    "curPage": 1,
      "pageSize": 10,
        "params": {
            "sn": "1314",
            "employeeNo": "2956"
        }
    }
}
参数名 类型 必填 描述
sn String Y 设备序列号
employeeNo String N 人员编号,当employeeNo为空则查询该设备下所有人员的核验信息
curPage Integer N 分页查询条件，分页页码，默认第1页
pageSize Integer N 分页查询条件，分页大小，默认每页10条，不超过20条

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success",
    "payload": {
      "totalRecords": 4,
    "curPage": 1,
    "totalPages": 1,
    "pageSize": 10,
        "results": [{
            "employeeNo": "2956",
            "facePhotoCount": 0,
            "fingerCount": 1,
            "faceCount": 0,
            "palmPrintCount": 0,
            "devicePermission": "14",
            "cardNo": "421343",
            "devicePassword": "41341",
            "deviceVerifyMode": "0"
        }]
    }
}
参数名 类型 描述
curPage Integer 分页页码
pageSize Integer 分页大小
totalRecords Integer 总记录数
totalPages Integer 总条数
employeeNo String 人员编号
facePhotoCount Integer 可见光人脸数
fingerCount Integer 指纹数
faceCount Integer 面部（近红外人脸）数
palmPrintCount Integer 掌纹数
devicePermission String 人员在设备的权限，0:普通人员(默认), 14:管理员
cardNo String 卡号
devicePassword String 人员设备密码
deviceVerifyMode String 验证方式，详见验证方式说明

1.4.3.9. 删除人员生物模板信息

删除人员生物模板信息后，改人员所在的所有设备上将删除该模板信息；若人员需要该生物模板信息进行核验，需重新登记，请谨慎删除

Request:

POST /v1.0/hr/employee/biotemplate/delete
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956",
            "type": "1"
        }
    }
}
参数名 类型 必填 描述
employeeNo String Y 人员编号
type String Y 生物特征类别，详见生物特征类别说明

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success"
}

1.4.3.10. 查询人员人脸照片

查询人员人脸照片接口请求

Request:

POST /v1.0/hr/employee/face/query
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956"
        }
    }
}
参数名 类型 必填 描述
employeeNo String Y 人员编号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success",
    "payload": {
        "results": {
             "facePhoto": "xxxx"
        }
    }
}
参数名 类型 描述
facePhoto String 人脸照片的base64字符串

results matching ""

    No results matching ""