1.11.1. 获取设备打卡记录

支持的版本:v1.2.3 +

查询指定时间段内的打卡记录

接口限制及注意事项【重要】:

  1. 只能查询3个月之内的数据;
  2. 查询时间段不能超过31天;
  3. 查询时间段不能跨月查询;
  4. 此接口返回全部结果集,调用方需自行根据实际情况选择合适时间段查询;

Request:

POST /v1.0/device/event/punchRecord/get
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "startTime": 1492617600,
            "endTime": 1492790400,
            "pushStartTime": 1492617600,
            "pushEndTime": 1492790400
        }
    }
}
参数名 必填 描述
startTime N 打卡开始Unix时间戳,精确到秒(默认查询条件)
endTime N 打卡截止Unix时间戳,精确到秒,为空时默认当前时间(默认查询条件)
pushStartTime N 开始Unix时间戳,精确到秒,此处指设备将记录推送到服务端的时间
pushEndTime N 截止Unix时间戳,精确到秒,此处指设备将记录推送到服务端的时间,为空时默认当前时间

注意事项:

本接口支持按打卡时间查询和按记录推送到服务端的时间查询,如果选择按打卡时间查询,请传startTime和endTime;如果选择按记录推送到服务端的时间查询,请传pushStartTime和pushEndTime;startTime和pushStartTime至少一个条件不为空。

Response:

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "results": [{
            "sn": "",
            "employeeNo": "",
            "punchTime": 1492617600,
            "iso8601PunchTime": "2019-06-03T09:01:01+08:00",
            "workCode": "",
            "status": "0",
            "pushTime": 1492617600,
            "temperature": "36.50",
            "maskStatus": "1"
        }]
    }
}
参数名 描述
sn 打卡设备序列号
employeeNo 打卡员工工号
punchTime 打卡时间戳
iso8601PunchTime 打卡时间(iso8601标准格式)
workCode 工作代码
status 打卡状态,0 上班签到,1 下班签退,2 外出,3 外出返回,4 加班签到,5 加班签退,255 默认
pushTime 记录推送到服务器的时间
temperature 体温。此属性配合设备使用,当设备带体温检测功能才有返回值
maskStatus 是否佩戴口罩,0 未佩戴口罩,1 已佩戴口罩。此属性配合设备使用,当设备带口罩检测功能才有返回值

1.11.2. 分页获取设备打卡记录

支持的版本:v1.2.4 +

查询指定时间段内的打卡记录,分页返回结果

Request:

POST /v1.0/device/event/punchRecord/getByPage
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "curPage": 1,
        "pageSize": 10,
        "params": {
            "startTime": 1492617600,
            "endTime": 1492790400,
            "pushStartTime": 1492617600,
            "pushEndTime": 1492790400
        }
    }
}
参数名 必填 描述
curPage N 分页查询条件,分页页码,默认第1页
pageSize N 分页查询条件,分页大小,默认每页10条,不超过20条
startTime N 打卡开始Unix时间戳,精确到秒(默认查询条件)
endTime N 打卡截止Unix时间戳,精确到秒,为空时默认当前时间(默认查询条件)
pushStartTime N 开始Unix时间戳,精确到秒,此处指设备将记录推送到服务端的时间
pushEndTime N 截止Unix时间戳,精确到秒,此处指设备将记录推送到服务端的时间,为空时默认当前时间

注意事项:

本接口支持按打卡时间查询和按记录推送到服务端的时间查询,如果选择按打卡时间查询,请传startTime和endTime;如果选择按记录推送到服务端的时间查询,请传pushStartTime和pushEndTime;startTime和pushStartTime至少一个条件不为空。

Response:

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "totalRecords": 4,
        "curPage": 1,
        "totalPages": 1,
        "pageSize": 10,
        "results": [{
            "sn": "",
            "employeeNo": "",
            "punchTime": 1492617600,
            "iso8601PunchTime": "2019-06-03T09:01:01+08:00",
            "workCode": "",
            "status": "0",
            "pushTime": 1492617600,
            "temperature": "36.50",
            "maskStatus": "1"
        }]
    }
}
参数名 描述
curPage 分页页码
pageSize 分页大小
totalRecords 总记录数
totalPages 总分页数
sn 打卡设备序列号
employeeNo 打卡员工工号
punchTime 打卡时间戳
iso8601PunchTime 打卡时间(iso8601标准格式)
workCode 工作代码
status 打卡状态,0 上班签到,1 下班签退,2 外出,3 外出返回,4 加班签到,5 加班签退,255 默认
pushTime 记录推送到服务器的时间
temperature 体温。此属性配合设备使用,当设备带体温检测功能才有返回值
maskStatus 是否佩戴口罩,0 未佩戴口罩,1 已佩戴口罩。此属性配合设备使用,当设备带口罩检测功能才有返回值

1.11.3. 打卡记录校对

支持的版本:v1.2.3 +

  • 对账指定时间段内的打卡记录, 返回该时间段内打卡记录总数.

  • 第三方自行验证该时间段内存储的打卡记录数是否一致,不一致则可调用获取设备打卡记录接口重新获取打卡记录。

POST /v1.0/device/event/punchRecord/verify
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "startTime": 1492617600,
            "endTime": 1492790400,
            "pushStartTime": 1492617600,
            "pushEndTime": 1492790400
        }
    }
}
参数名 必填 描述
startTime N 打卡开始Unix时间戳,精确到秒(默认查询条件)
endTime N 打卡截止Unix时间戳,精确到秒,为空时默认当前时间(默认查询条件)
pushStartTime N 开始Unix时间戳,精确到秒,此处指设备将记录推送到服务端的时间
pushEndTime N 截止Unix时间戳,精确到秒,此处指设备将记录推送到服务端的时间,为空时默认当前时间

注意事项:

本接口支持按打卡时间查询和按记录推送到服务端的时间查询,如果选择按打卡时间查询,请传startTime和endTime;如果选择按记录推送到服务端的时间查询,请传pushStartTime和pushEndTime;startTime和pushStartTime至少一个条件不为空。

Response:

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "results": {
            "punchRecordSum": 999
        }
    }
}
参数名 描述
punchRecordSum 打卡记录总数

results matching ""

    No results matching ""