接口调用说明
- 不支持获取离职人员的考勤信息,离职人员的考勤数据可以在OA管理后台查询。
- 本接口获取应出勤天数字段值,只支持获取距今15天内的应出勤天数value值,超过15天后的应出勤天数value值为0。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/getcolumnval |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 appType-第三方企业应用 |
| 权限要求 | permission-qyapi_base-调用企业API时需要具备的基本权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 6d1bxxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| userid | String | 是 | manager4220 | 用户的userId。 |
| column_id_list | String | 是 | 129339038 | 报表列ID,可通过获取考勤报表列定义接口获取id参数值。多值用英文逗号分隔,最大长度20。 |
| from_date | Date | 是 | 2018-07-11 12:12:12 | 开始时间。 |
| to_date | Date | 是 | 2018-07-11 12:12:12 | 结束时间,结束时间减去开始时间必须在31天以内。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/attendance/getcolumnval" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=4bfc0fxxxx3916c7' \
-d 'column_id_list=1%2C2%2C3' \
-d 'from_date=2018-07-11+12%3A12%3A12' \
-d 'to_date=2018-07-11+12%3A12%3A12' \
-d 'userid=zhangsan'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getcolumnval");
OapiAttendanceGetcolumnvalRequest req = new OapiAttendanceGetcolumnvalRequest();
req.setUserid("manager4220");
req.setColumnIdList("129339038");
req.setFromDate(StringUtils.parseDateTime("2020-09-07 12:12:12"));
req.setToDate(StringUtils.parseDateTime("2020-09-09 12:12:12"));
OapiAttendanceGetcolumnvalResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGetcolumnvalRequest("https://api.dingtalk.io/topapi/attendance/getcolumnval")
req.userid="zhangsan"
req.column_id_list="1,2,3"
req.from_date="2018-07-11 12:12:12"
req.to_date="2018-07-11 12:12:12"
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 OapiAttendanceGetcolumnvalRequest;
$req->setUserid("zhangsan");
$req->setColumnIdList("1,2,3");
$req->setFromDate("2018-07-11 12:12:12");
$req->setToDate("2018-07-11 12:12:12");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/getcolumnval");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getcolumnval");
OapiAttendanceGetcolumnvalRequest req = new OapiAttendanceGetcolumnvalRequest();
req.Userid = "zhangsan";
req.ColumnIdList = "1,2,3";
req.FromDate = DateTime.Parse("2018-07-11 12:12:12");
req.ToDate = DateTime.Parse("2018-07-11 12:12:12");
OapiAttendanceGetcolumnvalResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | 45n2azecqj21 | 请求ID。 |
| errcode | Number | 0 | 返回码。 |
| result | ColumnValListForTopVo | 返回结果。 | |
| column_vals | ColumnValForTopVo[] | 列信息与列值数据。 | |
| column_vals | ColumnDayAndVal[] | 列值数据。 | |
| date | Date | 2020-09-09 00:00:00 | 日期。 |
| value | String | 1.0 | 列值。 |
| column_vo | ColumnForTopVo | 列信息。 | |
| id | Number | 129339038 | 报表列ID。 |
| fixed_value | String | 0 | 固定值。 说明 某些报表列是固定列值的,那么仅会在这个字段返回,不会在column_vals中返回。 |
响应体示例
{
"errcode": 0,
"result": {
"column_vals": [
{
"column_vals": [
{
"date": "2020-09-07 00:00:00",
"value": "1.0"
},
{
"date": "2020-09-08 00:00:00",
"value": "1.0"
},
{
"date": "2020-09-09 00:00:00",
"value": "1.0"
}
],
"column_vo": {
"id": 129339038
}
}
]
},
"request_id": "45n2azecqj21"
}