top
关闭

开发者登录

资源编目API

主要使用场景:主要开放了教学资源编目的基础信息API

1、获取教材章节

基础 需要授权

根据教材ID或者章节上级ID获取章节信息。

前置条件

获取接口访问凭证:accessToken

请求说明

url https://api.lyeduyun.com/rescBase/queryChapters?accessToken=ACCESS_TOKEN
请求方式 post
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

parentType

可选

String

1

0=根据教材ID查章节1=根据上级章节ID查章节

2

parentId

可选

String

64

parentType为0时parentId传教材ID;parentType为1时parentId传上级章节ID

3

retType

可选

String

1

返回类型:0=返回整棵子树1=返回下级节点

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

data

必选

JSON对象

-

返回结果集

3.1

chapterList

必选

Json对象

-

结果列表

3.1.1

chapterId

必选

String

-

章节ID

3.1.2

chapterTitle

必选

String

-

章节标题

3.1.3

chapterPid

必选

String

-

父章节ID,根节点为0

3.1.4

textbookId

必选

String

-

教材ID

3.1.5

depth

必选

Int

-

章节层级

3.1.6

isLeaf

必选

String

-

是否叶子节点Y=是N=否

示例

							请求报文:
{
    "parentType": "0",
    "parentId": "TEX0000******",
    "retType": "0"
}
应答报文:
   {
    "retCode": "000000",
    "retDesc": "success",
    "chapterList": [
        {
            "chapterId": "CHA000******",
            "chapterTitle": "一单元",
            "chapterPid": "0",
            "textbookId": "TEX0******",
            "chapterLevel": "2",
            "isLeaf": "N"
        },
        {
            "chapterId": "CHA000******",
            "chapterTitle": "二单元",
            "chapterPid": "0",
            "textbookId": "TEX00000******",
            "chapterLevel": "2",
            "isLeaf": "N"
        }
        ]
}
						

参数说明

请求参数消息体-文本类
序号 字段名 约束 类型 长度 说明

1

msgType

必选

String

10

消息类型,此时固定为:text

1.1

text

必选

Json

-

text消息体

1.1.1

content

必选

String

消息内容

示例

{
	"msgtype": "text",
	"text": {
		"content": "zhxy msg text test 12"
	}
}
											

参数说明

请求参数消息体-link类
序号 字段名 约束 类型 长度 说明

1

msgType

必选

String

10

消息类型,此时固定为:link

2

link

必选

Json

-

link消息体

2.1

pcUrl

必选

String

PC端消息点击链接地址

2.2

appUrl

必选

String

移动客户端点击消息时跳转到的H5地址

2.3

title

必选

String

消息标题

2.4

busiId

必选

String

对应业务的id

2.5

content

必选

String

消息描述

2.6

picUrl

必选

String

图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片

示例

{
	"msgtype": "link",
	"link": {
		"pcUrl": "http://www.baidu.com",
		"appUrl": "http://www.baidu.com",
		"picUrl": "http://xxx.yyy.com/zzz.jpg",
		"content": "百度一下",
		"title": "百度",
		"busiId":"AQWER1234"
	}
}
											

参数说明

请求参数消息体-oa类
序号 字段名 约束 类型 长度 说明

1

msgType

必选

String

10

消息类型,此时固定为:oa

2

busiId

必选

String

-

该条oa消息在业务系统对应的id

3

pcUrl

必选

String

消息点击链接地址

4

appUrl

必选

String

移动客户端点击消息时跳转到的H5地址

5

oa

必选

Json

-

oa类型消息体

5.1

head

必选

Json

255

消息头部Json

5.1.1

text

必选

String

255

消息的头部标题

5.1.2

bgColor

可选

String

消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000

5.2

body

可选

Json

消息体

5.2.1

title

可选

String

消息体的标题

5.2.2

content

可选

String

消息体的正文

5.2.3

imageUrl

可选

String

消息体中的图片url

5.2.4

fileCount

可选

String

自定义的附件数目。此数字仅供显示,不作验证

5.2.5

author

可选

String

自定义的作者名字

5.2.6

form

可选

Json数组

消息体的表单,最多6个

5.2.7

key

可选

String

消息体的关键字

5.2.8

value

可选

String

消息体的关键字对应的值

关闭

扫码登录更安全

空间登录

手机扫码,安全登录

二维码已失效 请点击刷新
请打开人人通空间APP扫一扫登录

手机扫码,安全登录

扫描成功!

请在手机上确认登录

取消二维码登录