top
关闭

开发者登录

资源编目API

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

1、获取学段列表

基础 不需要授权

根据教材数据关联获取学段信息。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/rescBase/queryPeriods?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

periodList

必选

Json对象

-

学段列表

3.1

periodId

必选

String

64

学段ID

3.2

periodName

必选

String

50

学段名称

3.3

sortNum

可选

Int

-

排序字段

示例

							请求报文:
   {
   }
    应答报文:
 {
  "retCode": "000000",
  "retDesc": "success",
  "periodList": [
    {
      "periodId": "xq",
      "periodName": "学前",
      "sortNum": 1
    },
    {
      "periodId": "xx",
      "periodName": "小学",
      "sortNum": 2
    },
    {
      "periodId": "cz",
      "periodName": "初中",
      "sortNum": 3
    },
    {
      "periodId": "pg",
      "periodName": "高中",
      "sortNum": 4
    },
    {
      "periodId": "zz",
      "periodName": "中职",
      "sortNum": 5
    }
  ]
}                    
						

2、获取学科列表

基础 不需要授权

根据教材数据关联获取学科信息。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/rescBase/querySubjects?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

periodId

可选

Body(json)

String

64

学段ID

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

subjectList

必选

JSON对象

-

学科列表

3.1

subjectId

可选

String

64

学科ID

3.2

subjectName

可选

String

50

学科名称

3.3

sortNum

可选

Integer

5

排序字段

示例

							请求报文:
{
    "periodId":"xx"
}
 应答报文:
   {"retCode": "000000",
    "retDesc": "success",
    "subjectList": [
        {
            "subjectId": "SUBL******",
            "subjectName": "语文"
        },
        {
            "subjectId": "GRAL******",
            "subjectName": "数学"
        }
    ]
}                            
						

3、获取版本列表

基础 不需要授权

根据教材数据关联获取教材版本信息。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/rescBase/queryEditions?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

periodId

可选

Body(json)

String

64

学段ID

2

subjectId

可选

Body(json)

String

64

学科ID

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

editionList

必选

Json对象

-

版本列表

3.1

editionId

可选

String

-

版本ID

3.2

editionName

可选

String

-

版本名称

3.3

sortNum

可选

Int

-

排序字段

示例

							请求报文:
{
    "periodId": "PERL******",
    "subjectId": "SUBL******" 
}
 应答报文:
   {
    "retCode": "000000",
    "retDesc": "success",
    "editionList": [
        {
            "editionId": "EDIL******",
            "editionName": "人教新课标版"
        },
        {
            "textbookId": "EDIL******",
            "textbookName": "人教课标版"
        }
      ]
}                                          
						

4、获取册别列表

基础 不需要授权

根据教材数据关联查询册别信息。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/rescBase/queryVolumes?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

periodId

可选

Body(json)

String

64

学段ID

2

subjectId

可选

Body(json)

String

64

学科ID

3

editionId

可选

Body(json)

String

64

教材版本ID

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

volumeList

必选

Json对象

-

版本列表

3.1

volumeId

可选

String

-

版本ID

3.2

volumeName

可选

String

-

版本名称

3.3

sortNum

可选

Int

-

排序字段

示例

							请求报文:
{
    "periodId": "PERL******",
    "subjectId": "SUBL******",
"editionId": "XCDD******" 
}
 应答报文:
   {
    "retCode": "000000",
    "retDesc": "success",
    "volumeList": [
            {
                "volumeId": "VOL0002",
                "volumeName": "第二册"
            },
            {
                "volumeId": "VOL0004",
                "volumeName": "选修一"
            }
        ]                                
						

5、获取教材列表

基础 不需要授权

根据条件获取教材列表。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/rescBase/queryTextbooks?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

periodId

可选

Body(json)

String

64

学段ID

2

subjectId

可选

Body(json)

String

64

学科ID

3

editionId

可选

Body(json)

String

64

教材版本ID

4

volumeId

可选

Body(json)

String

64

册别ID

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

textbookList

必选

Json对象

-

教材列表

3.1

textbookId

可选

String

64

教材ID

3.2

textbookName

可选

String

100

教材名称

3.3

Intro

可选

String

500

教材介绍

示例

							请求报文:
{
"editionId": "EDI0001",
"volumeId": "VOL0002",
"periodId": "PER0004"
"subjectId": "SUB0005"
} 
应答报文:
   {
"retCode": "000000,"
"retDesc": "success",
"textbookList": [{
"textbookId": "10134",
"textbookName": "小学语文人教课标版一年级上册(2001)",
"Intro": "小学语文人教课标版一年级上册"
},
{
"textbookId": "10138",
"textbookName": "小学语文人教课标版三年级上册(2001)",
"Intro": "小学语文人教课标版三年级上册"
}]
}                                                                                                                                    
						

6、获取教材章节

基础 不需要授权

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

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

parentType

可选

Body(json)

String

1

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

2

parentId

可选

Body(json)

String

64

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

3

retType

可选

Body(json)

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"
        }
        ]
}
						

7、获取年级列表

基础 不需要授权

根据教材数据关联查询年级信息。

前置条件

1、获取接口访问凭证:accessToken

请求说明

url http://ip:port/rescBase/queryGrades?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

periodId

可选

Body(json)

String

32

学段ID

2

subjectId

可选

Body(json)

String

32

学科ID

3

volumeId

可选

Body(json)

String

32

册别ID

4

editionId

可选

Body(json)

String

32

教材版本ID

返回说明

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

1

retCode

可选

String

6

000000:成功

2

retDesc

可选

String

100

结果描述

3

data

可选

JSON对象

-

结果集

3.1

gradeList

可选

JSON对象

-

年级列表

3.1.1

gradeId

可选

String

32

年级ID

3.1.2

aamGradeId

可选

String

32

aam年级ID

3.1.3

gradeName

可选

String

64

年级名称

3.1.4

sortNum

可选

Int

11

排序字段

示例

							请求报文:
{
    "periodId":"xx",
    "subjectId":"sub",
    "volumeId":"vol",
	"editionId":"edi"
}
返回报文:
{
  "result": "000000",
  "resultDesc": "success",
  "data": []
}
						

参数说明

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

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

消息体的关键字对应的值