ListTextbookAssistantBooks - 获取英语教材的书本

更新时间:

获取包含年级下的书本列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aicontent:ListTextbookAssistantBookslist
*全部资源
*

请求语法

POST /api/v1/textbookAssistant/teachingResource/ListBooks HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体对象。

bookIdstring

书本编号 ID

231698
gradestring

年级,取值范围 1-9,和年级 level 对应

1
volumestring

册次,0:全一册,1:上册,2:下册

1
versionstring

教材版本

人教版
pagestring

页码

1
maxResultsstring

每页最大条目数,最大值 20。

20
authTokenstring

接口调用授权码,可以通过获取"英语教材式 AI 老师功能使用授权码"接口获取。

tc_197bf5bb81889cc79eb51ae9b8c0cea3

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

B695B377-7029-5805-9DE2-1AAE06C1BF6B
successboolean

是否成功

true
errCodestring

错误码

B_USER_NOT_FOUND_EXCEPTION
errMessagestring

错误信息

用户不存在
httpStatusCodeinteger

HTTP 状态码

200
dataobject

返回数据对象。

paginationDataobject

分页数据

totalCountinteger

全量数据的条数

200
maxResultsinteger

本次查询单页的数据条数

20
currentPageinteger

当前页码。

1
bookListarray<object>

书本列表信息

书本列表object
bookIdstring

书本编号 Id

231698
isbnstring

国际标准书号

9787107382505
editionstring

版次

2024-7(1)
impressionstring

印次

2024-7(1)
publisherstring

出版社

人民教育出版社
versionstring

教材版本

人教版
subjectstring

学科

ENGLISH
gradestring

年级,取值范围 1-9,对应年级 level

3
volumestring

册次,0:全一册,1:上册,2:下册

0
authorstring

作者信息

吴欣
bookNamestring

书本名称

K12英语-人教版PEP三起-三年级上册
coverImagestring

书本封面

null

示例

正常返回示例

JSON格式

{
  "requestId": "B695B377-7029-5805-9DE2-1AAE06C1BF6B",
  "success": true,
  "errCode": "B_USER_NOT_FOUND_EXCEPTION",
  "errMessage": "用户不存在",
  "httpStatusCode": 200,
  "data": {
    "paginationData": {
      "totalCount": 200,
      "maxResults": 20,
      "currentPage": 1
    },
    "bookList": [
      {
        "bookId": 231698,
        "isbn": 9787107382505,
        "edition": "2024-7(1)",
        "impression": "2024-7(1)",
        "publisher": "人民教育出版社",
        "version": "人教版",
        "subject": "ENGLISH",
        "grade": 3,
        "volume": 0,
        "author": "吴欣",
        "bookName": "K12英语-人教版PEP三起-三年级上册",
        "coverImage": null
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。