考勤打卡
该接口用于企业考勤系统接入使用,用于返回企业内部员工全部的打卡结果。
- 当前仅支持通过员工工号的方式去查询考勤相关数据。
- 接口目前仅返回一些考勤相关数据,不包含考勤是否异常;是否是法定假日加班等考勤处理数据。需要企业由接收数据的系统服务端自行处理。
请求格式说明
请求方式: POST(https)
认证方式: access_token,请参考获取access_token。
请求地址: https://open.welink.huaweicloud.com/api/attendance/v2/records
原V1接口仍然支持。
请求头部:
x-wlk-Authorization: access_token
Content-Type:application/json
请求参数:
{
"offset": 0,
"userIdList": ["w00123456", "w00123456"],
"dateFrom": "yyyy-mm-dd hh:mm:ss",
"dateTo": "yyyy-mm-dd hh:mm:ss",
"limit": 50
}
请求参数说明:
参数 | 参数类型 | 必填 | 说明 |
---|---|---|---|
offset | Int | 是 | 表示获取考勤数据的起始点 第一次传0,如果还有多余数据, 下次获取传的1、2...依次递增 |
userIdList | List | 否 | 此处userIdList指的是员工企业标识,员工企业标识需要在管理后台维护才可以查询,员工在企业内的员工工号列表,最多不能超过50个;如果没有维护员工企业标识,传递[],即默认获取全员当天的考勤数据 |
dateFrom | String | 是 | 查询考勤打卡记录的起始工作日。 |
dateTo | String | 是 | 查询考勤打卡记录的结束工作日。 注意,起始与结束工作日最多相隔24小时 |
limit | int | 是 | 表示获取考勤数据的条数, 最大不能超过100条 |
请求示例:
url -X POST \
https://open.welink.huaweicloud.com/api/attendance/v1/records \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{
"offset": 0,
"userIdList": ["员工工号1", "员工工号2"],
"dateFrom": "yyyy-mm-dd hh:mm:ss",
"dateTo": "yyyy-mm-dd hh:mm:ss",
"limit": 100}'
响应格式说明
返回结果:
{
"code": "0",
"message": "ok",
"totalCount": 32700,
"limit": 50,
"offset": 100,
"records": [
{
"id": "0170845db557459785522393192015ea",
"userId": "xxx@cloudlink",
"corpUserId": "1234567",
"userNameCn": "测试",
"checkTime": "2018-08-02 17:31:34",
"location": "天安云谷",
"longitude":"114.066873",
"latitude":"22.650278"
},
{
"id": "9719982fffe54ff899e197b7281df26d",
"userId": "xxx@cloudlink",
"corpUserId": "1234567",
"userNameCn": "测试",
"checkTime": "2018-08-02 17:31:33",
"location": "天安云谷",
"longitude":"114.066873",
"latitude":"22.650278"
}
]
}
返回参数说明:
参数 | 说明 |
---|---|
code | 数据正常返回“0”,如果发生错误,会返回对应的错误码 |
message | 返回信息,包括接口请求发生错误时的详细信息 |
totalCount | 总的数据条目 |
limit | 每次返回的数据量 |
offset | 数据偏移量即页码 |
data | 打卡数据 |
records | 打卡数据 |
id | 打卡记录的唯一id信息 |
corpUserId | 用户的账号信息(在WeLink平台注册信息) |
userId | 用户的工号信息 |
userNameCn | 用户的中文名字 |
checkTime | 打卡时间 |
location | 打卡地点 |
longitude | 打卡的经度 |
latitude | 打卡的纬度 |
错误码说明:
错误码 | 说明 |
---|---|
56100 | ok |
56101 | 接口参数缺少或参数类型错误 |
56102 | 查无数据 |
56104 | 认证信息为空或无效 |
56105 | 服务器内部错误 |