ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: GET \course/{id}/modules
Важно:
- C помощью метода вы можете получить список модулей (материалов и мероприятий), входящих в состав одного курса.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, роль с индивидуальными настройками и Автор курсов, у которого есть доступ к проекту, где находится этот курс.
Заголовки запроса
Параметр id в запросе — ID курса, список модулей которого вы хотите получить.
Заголовок | Описание |
---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
Параметры ответа
Заголовок | Описание |
---|---|
modules | Массив со списком модулей курса |
module | Массив с данными о модуле курса |
moduleId | ID модуля курса |
itemId | ID материала или мероприятия, входящих в состав курса. Этот параметр указывает на ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с параметром moduleId |
courseId | ID курса, в который входит модуль |
title | Название модуля курса |
description | Описание модуля курса |
authorId | ID автора материала (есть в ответе, только если type = material) |
addedDate | Дата создания материала или мероприятия, входящих в состав курса |
viewUrl | Ссылка на просмотр материала курса (есть в ответе, только если type = material) |
type | Тип модуля курса.
|
sequentialNumber | Порядковый номер модуля в курсе |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | OK | Запрос успешно обработан |
404 | Unknown content item | Не найден курс с указанным ID |
403 | Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
GET /course/a849d840-6a8a-11ef-b992-36bad3a603e7/modules HTTP/1.1 Host: api-learn.ispringlearn.ru Accept: application/json Authorization: gsTy154jePghm1yDv4scE9gKzqrjI8MXCXr4Yg4kz5A
Пример ответа
{ "modules": [ { "moduleId": "ec712528-6a8a-11ef-8749-be6337f13907", "itemId": "ec5e8328-6a8a-11ef-9bd7-36bad3a603e7", "courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7", "title": "Задание", "description": "Задание для стажёров", "authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2", "addedDate": "2024-09-04T06:57:17+00:00", "type": "material", "viewUrl": "https://courses.ispringlearn.ru/view/35050-KHrJL-8FRvR-hmBHP", "sequentialNumber": 1 }, { "moduleId": "0e028092-6a9a-11ef-b60f-c298d4afc52f", "itemId": "0dd3d554-6a9a-11ef-b4ad-723c165888c7", "courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7", "title": "Тест", "description": "Итоговое тестирование", "authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2", "addedDate": "2024-09-04T08:45:36+00:00", "type": "material", "viewUrl": "https://courses.ispringlearn.ru/view/35050-AcGpe-PFf7E-eBzuw", "sequentialNumber": 2 } ] }