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

dingtalk.oapi.edu.textbook.metadata.list (查询钉钉教育教材元数据列表)

钉钉教育生态主数据-查询教材元数据列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
cursor	Number	必须	0	游标
data_order_type	Number	可选	0	排序依赖字段类型
size	Number	必须	100	每页条数
level	Number	可选	1	层级
sort_type	Number	可选	0	排序规则（0:升序，1:降序）
op_user_id	String	必须	user4551	用户id
subject_code	String	必须	cn_p_shuxue	学科编码
parent_id	Number	可选	1012031	父教材id

响应参数

名称	类型	示例值	描述
result	PageQueryResponse	PageQueryResponse	数据对象
└ next_cursor Number 100 下一页游标 └ has_more Boolean false 是否还有更多数据 list TextbookMetadataDTO [] TextbookMetadataDTO[] 教育列表 └ textbook_name String 川教版（2018）教材版本名称 └ level Number 2 层级 └ remark String demo 备注 └ id Number 3 教材id └ subject_code String cn_m_xinxijishu 学科编码 └ parent_id Number 1 父id └ textbook_code String textbook0000050003 教材编码 └ status Number 0 系统自动生成 └ total_count Number 5 总数据条数
success	Boolean	true	是否调用成功
errcode	Number	0	错误编码
errmsg	String	ok	错误msg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/textbook/metadata/list");
OapiEduTextbookMetadataListRequest req = new OapiEduTextbookMetadataListRequest();
req.setCursor(0L);
req.setDataOrderType(0L);
req.setSize(100L);
req.setLevel(1L);
req.setSortType(0L);
req.setOpUserId("user4551");
req.setSubjectCode("cn_p_shuxue");
req.setParentId(1012031L);
OapiEduTextbookMetadataListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/textbook/metadata/list");
OapiEduTextbookMetadataListRequest req = new OapiEduTextbookMetadataListRequest();
req.Cursor = 0L;
req.DataOrderType = 0L;
req.Size = 100L;
req.Level = 1L;
req.SortType = 0L;
req.OpUserId = "user4551";
req.SubjectCode = "cn_p_shuxue";
req.ParentId = 1012031L;
OapiEduTextbookMetadataListResponse 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 OapiEduTextbookMetadataListRequest;
$req->setCursor("0");
$req->setDataOrderType("0");
$req->setSize("100");
$req->setLevel("1");
$req->setSortType("0");
$req->setOpUserId("user4551");
$req->setSubjectCode("cn_p_shuxue");
$req->setParentId("1012031");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/textbook/metadata/list");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/textbook/metadata/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=cec83199-929a-4393-bc21-cc9b44e5caf0' \
-d 'cursor=0' \
-d 'data_order_type=0' \
-d 'level=1' \
-d 'op_user_id=user4551' \
-d 'parent_id=1012031' \
-d 'size=100' \
-d 'sort_type=0' \
-d 'subject_code=cn_p_shuxue'

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

req=dingtalk.api.OapiEduTextbookMetadataListRequest("https://oapi.dingtalk.com/topapi/edu/textbook/metadata/list")

req.cursor=0
req.data_order_type=0
req.size=100
req.level=1
req.sort_type=0
req.op_user_id="user4551"
req.subject_code="cn_p_shuxue"
req.parent_id=1012031
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.textbook.metadata.list");
add_param(pRequest,"cursor","0");
add_param(pRequest,"data_order_type","0");
add_param(pRequest,"size","100");
add_param(pRequest,"level","1");
add_param(pRequest,"sort_type","0");
add_param(pRequest,"op_user_id","user4551");
add_param(pRequest,"subject_code","cn_p_shuxue");
add_param(pRequest,"parent_id","1012031");
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.textbook.metadata.list', {
	'cursor':'0',
	'data_order_type':'0',
	'size':'100',
	'level':'1',
	'sort_type':'0',
	'op_user_id':'user4551',
	'subject_code':'cn_p_shuxue',
	'parent_id':'1012031'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "next_cursor":100,
        "has_more":false,
        "list":[
            {
                    "textbook_name":"川教版（2018）",
                    "level":2,
                    "remark":"demo",
                    "id":3,
                    "subject_code":"cn_m_xinxijishu",
                    "parent_id":1,
                    "textbook_code":"textbook0000050003",
                    "status":0
            }
        ],
        "total_count":5
    },
    "success":true,
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.textbook.metadata.list (查询钉钉教育教材元数据列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ