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

dingtalk.oapi.attendance.vacation.type.create (假期类型添加)

添加假期类型

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
leave_name	String	必须	年假		假期名称
leave_view_unit	String	必须	day		请假单位，可以按照天半天或者小时请假。(day、halfDay、hour其中一种)
biz_type	String	必须	general_leave		假期类型，普通假期或者加班转调休假期。(general_leave、lieu_leave其中一种)
natural_day_leave	Boolean	必须	true		是否按照自然日统计请假时长，当为false的时候，用户发起请假时候会根据用户在请假时间段内的排班情况来计算请假时长
op_userid	String	必须	03085665764167		操作者ID
hours_in_per_day	Number	必须	1000		每天折算的工作时长(百分之一例如1天=10小时=1000)
extras	String	可选	{"validity_type":"absolute_time","validity_value":"12-31"}		调休假有效期规则(validity_type:有效类型 absolute_time(绝对时间)、relative_time(相对时间)其中一种 validity_value:延长日期(当validity_type为absolute_time该值该值不为空且满足yy-mm格式 validity_type为relative_time该值为大于1的整数))
visibility_rules	LeaveVisibilityRuleVo []	可选		最大列表长度：100	该假期类型的“适用范围”规则列表，不填默认为全公司
└ visible String [] 可选 userid1,userid2 规则数据：当type=staff时，传员工userId列表；当type=dept时，传部门id列表；当type=label时，传角色id列表 └ type String 可选 staff 规则类型：dept-部门；staff-员工；label-角色
when_can_leave	String	可选	entry		新员工请假：何时可以请假（entry-入职开始、formal-转正后）
paid_leave	Boolean	可选	true		是否带薪假期
freedom_leave	Boolean	可选	false		不需要余额控制的请假类型（如事假），默认false
leave_time_ceil_min_unit	String	可选	hour		请假时长向上取整时的最小时长单位：hour-不足1小时按照1小时计算；halfHour-不足半小时按照半小时计算
leave_time_ceil	Boolean	可选	false		是否开启请假时长是否向上取整
min_leave_hour	Number	可选	2		请假时，最小请假时长（请假单位为hour时生效），请假时长小于该值时自动取该值，有效值：[0, 23]
submit_time_rule	SubmitTimeRuleVO	可选			限时提交规则
└ time_value Number 可选 1 限制值：timeUnit=day时，有效值范围[0~30] 天；timeUnit=hour时，有效值范围[0~24] 小时 └ time_unit String 可选 day 时间单位：day-天；hour-小时 └ time_type String 可选 before 限制类型：before-提前；after-补交 └ enable_time_limit Boolean 可选 false 是否开启限时提交功能：仅且为true时开启
leave_certificate	LeaveCertificate	可选			请假证明
└ unit String 可选 hour 请假证明单位hour，day └ duration Number 可选 1 超过多长时间需提供请假证明 └ enable Boolean 可选 false 是否开启请假证明 └ prompt_information String 可选请假信息请假提示文案
max_leave_time	Number	可选	1		最大请假时长
leave_hour_ceil	String	可选	up		取整，up或者down

响应参数

名称	类型	示例值	描述
errcode	Number	0	错误码
errmsg	String	成功	错误消息
success	Boolean	true	是否正确访问
result	LeaveTypeVo		业务结果
└ leave_name String 年假假期名称 └ leave_code String 037477ae-1009-4632-b8e9-e919ae5e7973 假期类型唯一标识 └ leave_view_unit String day 请假单位，可以按照天半天或者小时请假。(day、halfDay、hour其中一种) └ biz_type String general_leave 假期类型，普通假期或者加班转调休假期。(general_leave、lieu_leave其中一种) └ natural_day_leave Boolean true 是否按照自然日统计请假时长，当为false的时候，用户发起请假时候会根据用户在请假时间段内的排班情况来计算请假时长。 └ hours_in_per_day Number 1000 每天折算的工作时长(百分之一例如1天=10小时=1000) visibility_rules LeaveVisibilityRuleVo [] 该假期类型的“适用范围”规则列表 └ visible String [] userid1,userid2 规则数据：当type=staff时，为员工userId列表；当type=dept时，为部门id列表；当type=label时，为角色id列表 └ type String staff 规则类型：dept-部门；staff-员工；label-角色 └ when_can_leave String entry 新员工请假：何时可以请假（entry-入职开始、formal-转正后） └ paid_leave Boolean true 是否带薪假期 └ freedom_leave Boolean false 不需要余额控制的请假类型（如事假） └ leave_time_ceil_min_unit String hour 请假时长向上取整时的最小时长单位：hour-不足1小时按照1小时计算；halfHour-不足半小时按照半小时计算 └ leave_time_ceil Boolean false 是否开启请假时长是否向上取整 └ min_leave_hour Number 2 请假时，最小请假时长（请假单位为hour时生效），请假时长小于该值时自动取该值，有效值：[0, 23] submit_time_rule SubmitTimeRuleVo {"enableTimeLimit":true,"timeType":"before","timeUnit":"day","timeValue":1} 限时提交规则 └ time_value Number 1 限制值：timeUnit=day时，有效值范围[0~30] 天；timeUnit=hour时，有效值范围[0~24] 小时 └ time_unit String day 时间单位：day-天；hour-小时 └ time_type String before 限制类型：before-提前；after-补交 └ enable_time_limit Boolean false 是否开启限时提交功能：仅且为true时开启 leave_certificate LeaveCertificate 请假证明 └ unit String hour 请假证明单位hour，day └ duration Number 1 超过多长时间需提供请假证明 └ enable Boolean false 是否开启请假证明 └ prompt_information String 请假信息请假提示文案 └ max_leave_time Number 1 最大请假时长 └ leave_hour_ceil String up 请假取整up或者down

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/attendance/vacation/type/create");
OapiAttendanceVacationTypeCreateRequest req = new OapiAttendanceVacationTypeCreateRequest();
req.setLeaveName("年假");
req.setLeaveViewUnit("day");
req.setBizType("general_leave");
req.setNaturalDayLeave(true);
req.setOpUserid("03085665764167");
req.setHoursInPerDay(1000L);
req.setExtras("{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}");
List<LeaveVisibilityRuleVo> list2 = new ArrayList<LeaveVisibilityRuleVo>();
LeaveVisibilityRuleVo obj3 = new LeaveVisibilityRuleVo();
list2.add(obj3);
obj3.setVisible("userid1,userid2");
obj3.setType("staff");
req.setVisibilityRules(list2);
req.setWhenCanLeave("entry");
req.setPaidLeave(true);
req.setFreedomLeave(false);
req.setLeaveTimeCeilMinUnit("hour");
req.setLeaveTimeCeil(false);
req.setMinLeaveHour(2L);
SubmitTimeRuleVO obj4 = new SubmitTimeRuleVO();
obj4.setTimeValue(1L);
obj4.setTimeUnit("day");
obj4.setTimeType("before");
obj4.setEnableTimeLimit(false);
req.setSubmitTimeRule(obj4);
LeaveCertificate obj5 = new LeaveCertificate();
obj5.setUnit("hour");
obj5.setDuration(1L);
obj5.setEnable(false);
obj5.setPromptInformation("请假信息");
req.setLeaveCertificate(obj5);
req.setMaxLeaveTime(1L);
req.setLeaveHourCeil("up");
OapiAttendanceVacationTypeCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/attendance/vacation/type/create");
OapiAttendanceVacationTypeCreateRequest req = new OapiAttendanceVacationTypeCreateRequest();
req.LeaveName = "年假";
req.LeaveViewUnit = "day";
req.BizType = "general_leave";
req.NaturalDayLeave = true;
req.OpUserid = "03085665764167";
req.HoursInPerDay = 1000L;
req.Extras = "{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}";
List<OapiAttendanceVacationTypeCreateRequest.LeaveVisibilityRuleVoDomain> list2 = new List<OapiAttendanceVacationTypeCreateRequest.LeaveVisibilityRuleVoDomain>();
OapiAttendanceVacationTypeCreateRequest.LeaveVisibilityRuleVoDomain obj3 = new OapiAttendanceVacationTypeCreateRequest.LeaveVisibilityRuleVoDomain();
list2.Add(obj3);
obj3.Visible = "userid1,userid2";
obj3.Type = "staff";
req.VisibilityRules_ = list2;
req.WhenCanLeave = "entry";
req.PaidLeave = true;
req.FreedomLeave = false;
req.LeaveTimeCeilMinUnit = "hour";
req.LeaveTimeCeil = false;
req.MinLeaveHour = 2L;
OapiAttendanceVacationTypeCreateRequest.SubmitTimeRuleVODomain obj4 = new OapiAttendanceVacationTypeCreateRequest.SubmitTimeRuleVODomain();
obj4.TimeValue = 1L;
obj4.TimeUnit = "day";
obj4.TimeType = "before";
obj4.EnableTimeLimit = false;
req.SubmitTimeRule_ = obj4;
OapiAttendanceVacationTypeCreateRequest.LeaveCertificateDomain obj5 = new OapiAttendanceVacationTypeCreateRequest.LeaveCertificateDomain();
obj5.Unit = "hour";
obj5.Duration = 1L;
obj5.Enable = false;
obj5.PromptInformation = "请假信息";
req.LeaveCertificate_ = obj5;
req.MaxLeaveTime = 1L;
req.LeaveHourCeil = "up";
OapiAttendanceVacationTypeCreateResponse 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 OapiAttendanceVacationTypeCreateRequest;
$req->setLeaveName("年假");
$req->setLeaveViewUnit("day");
$req->setBizType("general_leave");
$req->setNaturalDayLeave("true");
$req->setOpUserid("03085665764167");
$req->setHoursInPerDay("1000");
$req->setExtras("{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}");
$visibility_rules = new LeaveVisibilityRuleVo;
$visibility_rules->visible="userid1,userid2";
$visibility_rules->type="staff";
$req->setVisibilityRules(array($visibility_rules));
$req->setWhenCanLeave("entry");
$req->setPaidLeave("true");
$req->setFreedomLeave("false");
$req->setLeaveTimeCeilMinUnit("hour");
$req->setLeaveTimeCeil("false");
$req->setMinLeaveHour("2");
$submit_time_rule = new SubmitTimeRuleVO;
$submit_time_rule->time_value="1";
$submit_time_rule->time_unit="day";
$submit_time_rule->time_type="before";
$submit_time_rule->enable_time_limit="false";
$req->setSubmitTimeRule($submit_time_rule);
$leave_certificate = new LeaveCertificate;
$leave_certificate->unit="hour";
$leave_certificate->duration="1";
$leave_certificate->enable="false";
$leave_certificate->prompt_information="请假信息";
$req->setLeaveCertificate($leave_certificate);
$req->setMaxLeaveTime("1");
$req->setLeaveHourCeil("up");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/attendance/vacation/type/create");

curl -X POST "https://oapi.dingtalk.com/topapi/attendance/vacation/type/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=3020dbd6-a76e-45bf-9a49-d38b0b93a8eb' \
-d 'biz_type=general_leave' \
-d 'extras=%7B%5C%22validity_type%5C%22%3A%5C%22absolute_time%5C%22%2C%5C%22validity_value%5C%22%3A%5C%2212-31%5C%22%7D' \
-d 'freedom_leave=false' \
-d 'hours_in_per_day=1000' \
-d 'leave_certificate=null' \
-d 'leave_hour_ceil=up' \
-d 'leave_name=%E5%B9%B4%E5%81%87' \
-d 'leave_time_ceil=false' \
-d 'leave_time_ceil_min_unit=hour' \
-d 'leave_view_unit=day' \
-d 'max_leave_time=1' \
-d 'min_leave_hour=2' \
-d 'natural_day_leave=true' \
-d 'op_userid=03085665764167' \
-d 'paid_leave=true' \
-d 'submit_time_rule=null' \
-d 'visibility_rules=null' \
-d 'when_can_leave=entry'

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

req=dingtalk.api.OapiAttendanceVacationTypeCreateRequest("https://oapi.dingtalk.com/topapi/attendance/vacation/type/create")

req.leave_name="年假"
req.leave_view_unit="day"
req.biz_type="general_leave"
req.natural_day_leave=true
req.op_userid="03085665764167"
req.hours_in_per_day=1000
req.extras="{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}"
req.visibility_rules=""
req.when_can_leave="entry"
req.paid_leave=true
req.freedom_leave=false
req.leave_time_ceil_min_unit="hour"
req.leave_time_ceil=false
req.min_leave_hour=2
req.submit_time_rule=""
req.leave_certificate=""
req.max_leave_time=1
req.leave_hour_ceil="up"
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.vacation.type.create");
add_param(pRequest,"leave_name","年假");
add_param(pRequest,"leave_view_unit","day");
add_param(pRequest,"biz_type","general_leave");
add_param(pRequest,"natural_day_leave","true");
add_param(pRequest,"op_userid","03085665764167");
add_param(pRequest,"hours_in_per_day","1000");
add_param(pRequest,"extras","{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}");
add_param(pRequest,"visibility_rules","数据结构JSON示例");
add_param(pRequest,"when_can_leave","entry");
add_param(pRequest,"paid_leave","true");
add_param(pRequest,"freedom_leave","false");
add_param(pRequest,"leave_time_ceil_min_unit","hour");
add_param(pRequest,"leave_time_ceil","false");
add_param(pRequest,"min_leave_hour","2");
add_param(pRequest,"submit_time_rule","数据结构JSON示例");
add_param(pRequest,"leave_certificate","数据结构JSON示例");
add_param(pRequest,"max_leave_time","1");
add_param(pRequest,"leave_hour_ceil","up");
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.vacation.type.create', {
	'leave_name':'年假',
	'leave_view_unit':'day',
	'biz_type':'general_leave',
	'natural_day_leave':'true',
	'op_userid':'03085665764167',
	'hours_in_per_day':'1000',
	'extras':'{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}',
	'visibility_rules':'数据结构JSON示例',
	'when_can_leave':'entry',
	'paid_leave':'true',
	'freedom_leave':'false',
	'leave_time_ceil_min_unit':'hour',
	'leave_time_ceil':'false',
	'min_leave_hour':'2',
	'submit_time_rule':'数据结构JSON示例',
	'leave_certificate':'数据结构JSON示例',
	'max_leave_time':'1',
	'leave_hour_ceil':'up'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"成功",
    "success":true,
    "result":{
        "leave_name":"年假",
        "leave_code":"037477ae-1009-4632-b8e9-e919ae5e7973",
        "leave_view_unit":"day",
        "biz_type":"general_leave",
        "natural_day_leave":true,
        "hours_in_per_day":1000,
        "visibility_rules":[
            {
                    "visible":{
                        "string":[
                            "userid1",
                            "userid2"
                        ]
                    },
                    "type":"staff"
            }
        ],
        "when_can_leave":"entry",
        "paid_leave":true,
        "freedom_leave":false,
        "leave_time_ceil_min_unit":"hour",
        "leave_time_ceil":false,
        "min_leave_hour":2,
        "submit_time_rule":{
            "time_value":1,
            "time_unit":"day",
            "time_type":"before",
            "enable_time_limit":false
        },
        "leave_certificate":{
            "unit":"hour",
            "duration":1,
            "enable":false,
            "prompt_information":"请假信息"
        },
        "max_leave_time":1,
        "leave_hour_ceil":"up"
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.attendance.vacation.type.create (假期类型添加)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ