| Включить страницу |
|---|
| Лэйблы с указанием тарифа |
|---|
| Лэйблы с указанием тарифа |
|---|
|
Запрос: POST /course/tree
С помощью метода вы можете получить дерево курсов и других элементов контента.
Права пользователя для выполнения запроса
Пользователи с ролью Владелец аккаунта, Администратор аккаунта, Администратор подразделения, ролью с индивидуальными настройками и Автор курсов, у которых есть доступ к материалам.
Заголовки запроса
| Заголовок | Описание |
| Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
Content-Type: application/json
(обязательный)
| Свойство для обработки запроса в JSON. |
Accept: application/json
(обязательный)
| Свойство для получения данных в формате JSON. |
Параметры запроса
| Параметр | Описание |
| itemId (необязательный) | ID элемента дерева, который вы хотите получить |
Параметры ответа
| Параметр | Описание |
| itemId | ID элемента |
| title | Название элемента |
| type | Тип элемента |
| description | Описание элемента |
| addedDate | Дата добавления элемента |
| viewUrl | Ссылка на просмотр элемента |
| parentId | ID родительского элемента |
| isShared | true, если элемент является общим, иначе — false |
Параметр type содержит тип элемента дерева:
- iSpringSuiteModule
- Course
- Page
- Folder
- Link
- SCORM
- LearningTrack
- PowerPointPresentation
- WordDocument
- PDFDocument
- ExcelSpreadsheet
- OnlineQuiz
- Quiz
- RolePlay
- Book
- Interaction
- Video
- Audio
- Assignment
- ExternalCourse
Коды ответов
| Код | Текст | Описание |
| 200 | OK | Запрос успешно обработан |
| 400 | Bad Request | Ошибка в запросе |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
| панель |
|---|
POST /course/tree?itemId=cdcc8b68-3c12-11f1-8f8c-ce3ca9be27b7 HTTP/1.1
Host: api-learn.ispringlearn.ru
Accept: application/json
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
Пример ответа
| Блок кода |
|---|
|
[
{
"itemId": "cdcc8b68-3c12-11f1-8f8c-ce3ca9be27b7",
"title": "Информационная безопасность",
"type": "Course",
"parentId": "0",
"isShared": false
},
{
"itemId": "d8b95c1f-3c12-11f1-bbd0-9a42ef69602a",
"title": "Как установить безопасный пароль",
"type": "Page",
"parentId": "cdcc8b68-3c12-11f1-8f8c-ce3ca9be27b7",
"isShared": false
}
] |