获取可补卡时间
获取用户某天可以补的第几次上 / 下班卡的时间。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/attendance/v1/user_task_remedys/query_user_allowed_remedys |
| HTTP Method | POST |
| 接口频率限制 | 50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | attendance:task:readonly 导出打卡数据 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
employee_type | string | 是 | 响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用通过手机号或邮箱获取用户 ID 示例值:employee_id 可选值有: - employee_id: 员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - employee_no: 员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id | string | 是 | 用户 ID,对应employee_type 示例值:"abd754f7" |
remedy_date | int | 是 | 补卡日期,格式为yyyyMMdd 示例值:20210104 |
请求体示例
json
{
"user_id": "abd754f7",
"remedy_date": 20210104
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ user_allowed_remedys | user_allowed_remedy\[\] | 用户可补卡时间 |
└ user_id | string | 用户 ID,对应employee_type |
└ remedy_date | int | 补卡日期,格式为yyyyMMdd |
└ is_free_punch | boolean | 是否为自由班次,若为自由班次,则不用选择考虑第几次上下班,直接选择补卡时间即可 |
└ punch_no | int | 第几次上下班,0:第 1 次上下班,1:第 2 次上下班,2:第 3 次上下班 |
└ work_type | int | 上班 / 下班,1:上班,2:下班 |
└ punch_status | string | 打卡状态,Early:早退,Late:迟到,Lack:缺卡 |
└ normal_punch_time | string | 正常的应打卡时间,时间格式为 yyyy-MM-dd HH:mm |
└ remedy_start_time | string | 可选的补卡时间的最小值,时间格式为 yyyy-MM-dd HH:mm |
└ remedy_end_time | string | 可选的补卡时间的最大值,时间格式为 yyyy-MM-dd HH:mm |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"user_allowed_remedys": [
{
"user_id": "abd754f7",
"remedy_date": 20210104,
"is_free_punch": false,
"punch_no": 0,
"work_type": 1,
"punch_status": "Lack",
"normal_punch_time": "2021-07-01 09:00",
"remedy_start_time": "2021-07-01 08:00",
"remedy_end_time": "2021-07-01 10:00"
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1220001 | param is invalid | 入参校验失败,请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持 |
| 400 | 1220002 | tenant_id is empty | 请检查入参中的 tenant_access_token是否正确 |
| 400 | 1220004 | param is invalid | 请参考实际返回的错误信息排查问题。例如“user_id is not exist or does not have permission”代表入参传入的用户id不存在或者没有权限。如仍无法解决可联系 技术支持 |
| 400 | 1220005 | 没有权限 | 请前往考勤管理后台检查数据权限范围 |
| 500 | 1225000 | param is invalid | 请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持 |
| 500 | 1226500 | 历史错误码,不再使用 | - |
| 400 | 1226501 | no need remedy | 当天没有异常考勤,无需补卡 |
| 400 | 1226502 | not allowed remedy | 考勤组设置不允许补卡 |
| 400 | 1226503 | approval time beyond the time range | 考勤组设置只允许补过去多少天的卡,超出可补卡日期 |
| 400 | 1226504 | no remedy time left | 超出补卡次数,当前周期的补卡次数已用完 |
| 500 | 1227500 | param is invalid | 班次服务异常错误码,请参考实际返回的错误信息排查问题。例如“[BatchGetLarkIDByOpenID] not find user larkID”代表没有找到对应lark uid。如仍无法解决可联系 技术支持 |
| 400 | 1220600 | 通用错误信息 | 通用错误信息包含多条,详细的错误信息以及处理建议可参见错误信息。 |
