ListTextbookAssistantBookDirectories-Smart Science and Education Content Platform(SSECP)-阿里云帮助中心

Gets the table of contents of a book.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aicontent:ListTextbookAssistantBookDirectories

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
bookId	string	Yes	The book ID. You can obtain this ID from the API for retrieving English textbooks.	231698
scenario	string	Yes	The exercise scenario. Valid values: EXPAND : Supplementary exercise. ALL : All scenarios. SYNC : Synchronous exercise.	SYNC
authToken	string	Yes	The API authorization token. You can obtain this token from the authorization API for the AI English teacher feature.	tc_e6dc70c890866f4028ca685b6fa29874

Response elements

Element	Type	Description	Example
	object	Response schema.
requestId	string	The request ID.	0A5E9849-A2F0-551D-A7D8-1A8118557BAB
success	boolean	Indicates whether the request succeeded.	true
errCode	string	The error code.	B_USER_NOT_FOUND_EXCEPTION
errMessage	string	The error message.	用户不存在
httpStatusCode	integer	The HTTP status code.	200
data	object	The data object.
editionInfo	object	The edition details.
bookId	string	The book ID.	55857
isbn	string	The International Standard Book Number (ISBN).	9787544413695
edition	string	The edition.	2010-1(2)
impression	string	The impression.	2019-1(10)
publisher	string	The publisher.	人民教育出版社
version	string	The version.	人教版
subject	string	The subject.	ENGLISH
grade	string	The grade. Valid values: 1–9.	3
bookVolume	string	The book volume. `0` indicates a single-volume edition, `1` indicates Volume 1, and `2` indicates Volume 2.	1
directoryTree	array<object>	The directory tree.
	array<object>
directoryId	string	The directory ID.	05758807ed8e11eebe6e0c42a106bb02
directoryName	string	The directory name.	2 Jobs
topic	array<object>	The topic.
	object
labelId	string	The label ID.	1323
labelName	string	The label name.	身边事物环境
unit	array<object>	The unit.
	array<object>
directoryId	string	The directory ID.	05758807ed8e11eebe6e0c42a106bb02
directoryName	string	The directory name.	unit 2
topic	array<object>	The topic.
	object
labelId	string	The label ID.	1326
labelName	string	The label name.	自我介绍
section	array<object>	The section.
	array<object>
directoryId	string	The directory ID.	05758807ed8e11eebe6e0c42a106bb02
directoryName	string	The directory name.	section 2
topic	array<object>	The topic.
	object	Topic details.
labelId	string	The label ID.	1329
labelName	string	The label name.	自我介绍
children	any	Child nodes for backward compatibility. This property is optional.	可能存在的子元素，兼容数据使用，不一定存在

Examples

Success response

JSON format

{
  "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": "可能存在的子元素，兼容数据使用，不一定存在"
              }
            ]
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.