文档中心 > API类目 > 钉钉API

dingtalk.oapi.attendance.listschedule (考勤排班信息按天全量查询接口)

按天查询企业考勤排班全量信息，使用分页功能

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
workDate	Date	必须	2016-03-09 11:11:11		排班时间，只取年月日部分
offset	Number	可选	0	默认值：0	偏移位置
size	Number	可选	200	默认值：200	分页大小，最大200

响应参数

名称	类型	示例值	描述
result	AtScheduleListForTopVo		result
schedules AtScheduleForTopVo [] schedules └ plan_id Number 1 排班id └ check_type String OnDuty 打卡类型，Onduty表示上班打卡，OffDuty表示下班打卡 └ approve_id Number 1 审批id,结果集中没有的话表示没有审批单 └ userid String 0001 userId └ class_id Number 1 考勤班次id └ class_setting_id Number 1 班次配置id，结果集中没有的话表示使用全局班次配置 └ plan_check_time Date 2017-04-11 11:11:11 打卡时间 └ group_id Number 1 考勤组id └ changed_check_time Date 2017-04-11 11:11:11 调整后的卡点时间 └ has_more Boolean false 分页用，表示是否还有下一页
errmsg	String	ok	errmsg
errcode	Number	0	errcode

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/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());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/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);

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://oapi.dingtalk.com/topapi/attendance/listschedule");

curl -X POST "https://oapi.dingtalk.com/topapi/attendance/listschedule" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e91cb38b-4d9b-4cfe-bc8d-fece2408222b' \
-d 'offset=0' \
-d 'size=200' \
-d 'workDate=2016-03-09+11%3A11%3A11'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiAttendanceListscheduleRequest("https://oapi.dingtalk.com/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)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.attendance.listschedule");
add_param(pRequest,"workDate","2016-03-09 11:11:11");
add_param(pRequest,"offset","0");
add_param(pRequest,"size","200");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.attendance.listschedule', {
	'workDate':'2016-03-09 11:11:11',
	'offset':'0',
	'size':'200'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "schedules":[
            {
                    "plan_id":1,
                    "check_type":"OnDuty",
                    "approve_id":1,
                    "userid":"0001",
                    "class_id":1,
                    "class_setting_id":1,
                    "plan_check_time":"2017-04-11 11:11:11",
                    "group_id":1,
                    "changed_check_time":"2017-04-11 11:11:11"
            }
        ],
        "has_more":false
    },
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.attendance.listschedule (考勤排班信息按天全量查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ