获取书本下的目录信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aicontent:ListTextbookAssistantBookDirectories | list | *全部资源 * |
| 无 |
请求语法
POST /api/v1/textbookAssistant/teachingResource/ListBookDirectories HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求体对象。 | |
| bookId | string | 是 | 书本编号 Id,可以通过”获取英语教材的书本“接口中获取 | 231698 |
| scenario | string | 是 | 选择场景数据。SYNC:同步练习,EXPAND:拓展练习 枚举值:
| SYNC |
| authToken | string | 是 | 接口调用授权码,可以通过获取"英语教材式 AI 老师功能使用授权码"接口获取。 | tc_e6dc70c890866f4028ca685b6fa29874 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "0A5E9849-A2F0-551D-A7D8-1A8118557BAB",
"success": true,
"errCode": "B_USER_NOT_FOUND_EXCEPTION",
"errMessage": "用户不存在",
"httpStatusCode": 200,
"data": {
"editionInfo": {
"bookId": 55857,
"isbn": 9787544413695,
"edition": "2010-1(2)",
"impression": "2019-1(10)",
"publisher": "人民教育出版社",
"version": "人教版",
"subject": "ENGLISH",
"grade": 3,
"bookVolume": 1
},
"directoryTree": [
{
"directoryId": "05758807ed8e11eebe6e0c42a106bb02",
"directoryName": "2 Jobs",
"topic": [
{
"labelId": 1323,
"labelName": "身边事物环境"
}
],
"unit": [
{
"directoryId": "05758807ed8e11eebe6e0c42a106bb02",
"directoryName": "unit 2",
"topic": [
{
"labelId": 1326,
"labelName": "自我介绍"
}
],
"section": [
{
"directoryId": "05758807ed8e11eebe6e0c42a106bb02",
"directoryName": "section 2",
"topic": [
{
"labelId": 1329,
"labelName": "自我介绍"
}
],
"children": "可能存在的子元素,兼容数据使用,不一定存在"
}
]
}
]
}
]
}
}错误码
访问错误中心查看更多错误码。
