开发指南接口调用说明
- 固定班制只能查到未来15天的排班信息。
- 本接口仅支持企业总人数10000人以下使用。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/listschedule |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 appType-第三方企业应用 |
| 权限要求 | permission-qyapi_base-调用企业API时需要具备的基本权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用，通过获取企业内部应用的access_token接口获取。 - 第三方企业应用，通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| workDate | Date | 是 | 2020-09-06 | 排班时间，只取年月日部分。 |
| offset | Number | 否 | 0 | 支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。 |
| size | Number | 否 | 200 | 分页大小，最大值200。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/attendance/listschedule" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=b9305xxxxea83' \
-d 'offset=0' \
-d 'size=200' \
-d 'workDate=2016-03-09+11%3A11%3A11'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/listschedule");
OapiAttendanceListscheduleRequest req = new OapiAttendanceListscheduleRequest();
req.setWorkDate(StringUtils.parseDateTime("2016-03-09 11:11:11"));
req.setOffset(0L);
req.setSize(200L);
OapiAttendanceListscheduleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceListscheduleRequest("https://api.dingtalk.io/topapi/attendance/listschedule")
req.workDate="2016-03-09 11:11:11"
req.offset=0
req.size=200
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAttendanceListscheduleRequest;
$req->setWorkDate("2016-03-09 11:11:11");
$req->setOffset("0");
$req->setSize("200");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/listschedule");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/listschedule");
OapiAttendanceListscheduleRequest req = new OapiAttendanceListscheduleRequest();
req.WorkDate = DateTime.Parse("2016-03-09 11:11:11");
req.Offset = 0L;
req.Size = 200L;
OapiAttendanceListscheduleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| result | AtScheduleListForTopVo | 查询结果。 | |
| schedules | AtScheduleForTopVo[] | 排班表。 | |
| plan_id | Number | 157062792171 | 排班ID。 |
| check_type | String | OnDuty | 打卡类型： - Onduty：上班打卡 - OffDuty：下班打卡 |
| approve_id | Number | 1 | 审批ID。 说明 没有审批单则不返回该参数。 |
| userid | String | user01 | 考勤的用户userId。 |
| class_id | Number | 677995086 | 考勤班次ID。 |
| class_setting_id | Number | 599315627 | 班次配置ID。 说明 使用全局配置则不返回该参数。 |
| plan_check_time | Date | 2020-11-11 09:30:00 | 打卡时间。 |
| group_id | Number | 685935028 | 考勤组ID。 |
| changed_check_time | Date | 2020-09-06 15:36:04 | 调整后的卡点时间。 |
| has_more | Boolean | false | 是否还有下一页。 - true：有 - false：没有 |
| errmsg | String | ok | 返回码描述。 |
| errcode | Number | 0 | 返回码。 |
| request_id | String | 6ha75i2o99fj | 请求ID。 |
响应体示例
{
"errcode": 0,
"errmsg":"ok",
"result": {
"has_more": false,
"schedules": [
{
"check_type": "OnDuty",
"class_id": 677995086,
"class_setting_id": 599315627,
"group_id": 685935028,
"plan_check_time": "2020-11-11 09:30:00",
"plan_id": 157062792171,
"userid": "user01"
},
{
"check_type": "OffDuty",
"class_id": 677995086,
"class_setting_id": 599315627,
"group_id": 685935028,
"plan_check_time": "2020-11-11 18:30:00",
"plan_id": 157062792172,
"userid": "user01"
}
]
},
"request_id": "6ha75i2o99fj"
}