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

dingtalk.oapi.edu.period.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。

请求参数

名称	类型	是否必须	示例值	描述
super_id	Number	必须	1233	校区id
operator	String	必须	12334	钉钉管理员
open_period	OpenPeriod	必须		学段信息
└ step String 必须小学学段名. 其枚举值：幼儿园/小学/初中/高中 grades Grades [] 必须年级 └ grade String 必须 2 年级level └ classes Number 必须 0 创建年级时，需要在此年级下创建多少个班级。允许填0. └ name String 必须二年级2019级年级名 └ start_year String 必须 2019 入学年份 └ period_code String 必须 high_school 幼儿园：kindergarten 小学：primary_school 初中： middle_school 高中： high_school └ name_mode String 必须 number number: 初中按照1,2,3年级命名。默认。 text: 初中按照6,7,8,9年级命名

响应参数

名称	类型	示例值	描述
result	OpenPeriodCreateResponse	{}	返回结果值
└ deptId Number 415999017 学段id grades EduGradeDo [] {} 年级id，有可能会空列表，需要通过读接口查询 └ campus_id Number 415999016 校区id └ dept_id Number 415998012 年级id └ grade Number 1 年级等级 └ name String 一年级2020级年级名 └ super_id Number 415999017 学段id
success	Boolean	true	是否成功
errcode	Number	0	错误码
errmsg	String	demo	错误消息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/period/create");
OapiEduPeriodCreateRequest req = new OapiEduPeriodCreateRequest();
req.setSuperId(1233L);
req.setOperator("12334");
OpenPeriod obj1 = new OpenPeriod();
obj1.setStep("小学");
List<Grades> list3 = new ArrayList<Grades>();
Grades obj4 = new Grades();
list3.add(obj4);
obj4.setGrade("2");
obj4.setClasses(0L);
obj4.setName("二年级2019级");
obj4.setStartYear("2019");
obj1.setGrades(list3);
obj1.setPeriodCode("high_school");
obj1.setNameMode("number");
req.setOpenPeriod(obj1);
OapiEduPeriodCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/period/create");
OapiEduPeriodCreateRequest req = new OapiEduPeriodCreateRequest();
req.SuperId = 1233L;
req.Operator = "12334";
OapiEduPeriodCreateRequest.OpenPeriodDomain obj1 = new OapiEduPeriodCreateRequest.OpenPeriodDomain();
obj1.Step = "小学";
List<OapiEduPeriodCreateRequest.GradesDomain> list3 = new List<OapiEduPeriodCreateRequest.GradesDomain>();
OapiEduPeriodCreateRequest.GradesDomain obj4 = new OapiEduPeriodCreateRequest.GradesDomain();
list3.Add(obj4);
obj4.Grade = "2";
obj4.Classes = 0L;
obj4.Name = "二年级2019级";
obj4.StartYear = "2019";
obj1.Grades= list3;
obj1.PeriodCode = "high_school";
obj1.NameMode = "number";
req.OpenPeriod_ = obj1;
OapiEduPeriodCreateResponse 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 OapiEduPeriodCreateRequest;
$req->setSuperId("1233");
$req->setOperator("12334");
$open_period = new OpenPeriod;
$open_period->step="小学";
$grades = new Grades;
$grades->grade="2";
$grades->classes="0";
$grades->name="二年级2019级";
$grades->start_year="2019";
$open_period->grades = array($grades);
$open_period->period_code="high_school";
$open_period->name_mode="number";
$req->setOpenPeriod($open_period);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/period/create");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/period/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a4ebfa0e-f6c7-4f65-8487-38b7b23e4b68' \
-d 'open_period=null' \
-d 'operator=12334' \
-d 'super_id=1233'

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

req=dingtalk.api.OapiEduPeriodCreateRequest("https://oapi.dingtalk.com/topapi/edu/period/create")

req.super_id=1233
req.operator="12334"
req.open_period=""
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.edu.period.create");
add_param(pRequest,"super_id","1233");
add_param(pRequest,"operator","12334");
add_param(pRequest,"open_period","数据结构JSON示例");
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.edu.period.create', {
	'super_id':'1233',
	'operator':'12334',
	'open_period':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "deptId":415999017,
        "grades":[
            {
                    "campus_id":415999016,
                    "dept_id":415998012,
                    "grade":1,
                    "name":"一年级2020级",
                    "super_id":415999017
            }
        ]
    },
    "success":true,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.edu.period.create (创建学段)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ