请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/getleavestatus |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 appType-第三方企业应用 |
| 权限要求 | permission-qyapi_get_attendance_data-考勤数据读权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 6d1bxxxx | 调用该接口的应用凭证,通过获取企业内部应用的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| userid_list | String | 是 | user456,user123 | 待查询用户的ID列表,每次最多100个。 |
| start_time | Number | 是 | 1538323200000 | 开始时间 ,Unix时间戳,支持最多180天的查询。 |
| end_time | Number | 是 | 1546358399000 | 结束时间,Unix时间戳,支持最多180天的查询。 |
| offset | Number | 是 | 0 | 支持分页查询,与size参数同时设置时才生效,此参数代表偏移量,偏移量从0开始。 |
| size | Number | 是 | 10 | 支持分页查询,与offset参数同时设置时才生效,此参数代表分页大小,最大20。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/attendance/getleavestatus" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=11b9xxxxc35a' \
-d 'end_time=1546358399000' \
-d 'offset=0' \
-d 'size=10' \
-d 'start_time=1538323200000' \
-d 'userid_list=123%2C121'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getleavestatus");
OapiAttendanceGetleavestatusRequest req = new OapiAttendanceGetleavestatusRequest();
req.setUseridList("user123,user456");
req.setStartTime(1538323200000L);
req.setEndTime(1546358399000L);
req.setOffset(0L);
req.setSize(10L);
OapiAttendanceGetleavestatusResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGetleavestatusRequest("https://api.dingtalk.io/topapi/attendance/getleavestatus")
req.userid_list="123,121"
req.start_time=1538323200000
req.end_time=1546358399000
req.offset=0
req.size=10
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 OapiAttendanceGetleavestatusRequest;
$req->setUseridList("123,121");
$req->setStartTime("1538323200000");
$req->setEndTime("1546358399000");
$req->setOffset("0");
$req->setSize("10");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/getleavestatus");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getleavestatus");
OapiAttendanceGetleavestatusRequest req = new OapiAttendanceGetleavestatusRequest();
req.UseridList = "123,121";
req.StartTime = 1538323200000L;
req.EndTime = 1546358399000L;
req.Offset = 0L;
req.Size = 10L;
OapiAttendanceGetleavestatusResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| errcode | Number | 0 | 返回码。 |
| result | LeaveStatusListVO | 查询结果。 | |
| has_more | Boolean | true | 是否有更多数据。 - true:有 - false:没有 |
| leave_status | LeaveStatusVO[] | 请假状态列表。 | |
| duration_unit | String | percent_day | 请假单位: - percent_day:天 - percent_hour:小时 |
| duration_percent | Number | 100 | 假期时长*100,例如用户请假时长为1天,该值就等于100。 |
| end_time | Number | 1599465600000 | 请假结束时间,Unix时间戳。 |
| start_time | Number | 1599372000000 | 请假开始时间,Unix时间戳。 |
| userid | String | user456 | 用户ID。 |
| success | Boolean | true | 请求是否成功。 - true:成功 - false:失败 |
| request_id | String | 5lbpbi9p1awk | 请求ID。 |
响应体示例
{
"errcode": 0,
"result": {
"has_more": false,
"leave_status": [
{
"duration_percent": 650,
"duration_unit": "percent_hour",
"end_time": 1599465600000,
"start_time": 1599372000000,
"leave_code":"16f856xxxx09aa16"
"userid": "user123"
}
]
},
"success": true,
"request_id": "5lbpbi9p1awk"
}