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

dingtalk.oapi.edu.period.get (查询学段信息)

学段信息查询接口，通过orgid，学段id查询学段信息，返回学段名称、nick、校区id

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
period_id	Number	必须	654321		学段ID

响应参数

名称	类型	示例值	描述
result	PeriodResponse	{ "result":{ "period_type":"high_school", "period_id":123, "name":"高中", "nick":"高中" }, "errcode":0, "errmsg":"msg", "success":true }	result
└ period_type String high_school 学段类型（幼儿园：kindergarten、小学：primary_school，初中：middle_school，高中：high_school） └ period_id Number 123 学段ID └ name String 高中学段名称 └ nick String 高中学段别名 └ campus_id Number 123 校区ID └ name_mode String text 学段名称类型，text表示文本型，如中学为七年级，八年级，九年级，number表示数字型，如初中一年级1班，二年级1班等
errcode	Number	0	错误码
errmsg	String	msg	错误信息
success	Boolean	true	成功状态

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/period/get");
OapiEduPeriodGetRequest req = new OapiEduPeriodGetRequest();
req.setPeriodId(654321L);
OapiEduPeriodGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/period/get");
OapiEduPeriodGetRequest req = new OapiEduPeriodGetRequest();
req.PeriodId = 654321L;
OapiEduPeriodGetResponse 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 OapiEduPeriodGetRequest;
$req->setPeriodId("654321");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/period/get");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/period/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e746d11b-0614-4698-8209-dbc5e78a208d' \
-d 'period_id=654321'

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

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

req.period_id=654321
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.get");
add_param(pRequest,"period_id","654321");
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.get', {
	'period_id':'654321'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "period_type":"high_school",
        "period_id":123,
        "name":"高中",
        "nick":"高中",
        "campus_id":123,
        "name_mode":"text"
    },
    "errcode":0,
    "errmsg":"msg",
    "success":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.edu.period.get (查询学段信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈