Запрос: GET \course/{id}/modules
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, роль с индивидуальными настройками и Автор курсов, у которого есть доступ к проекту, где находится этот курс.
Заголовки запроса
Параметр id в запросе — ID курса, список модулей которого вы хотите получить.
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (required) | Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru. |
| X-Auth-Email (required) | Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора курсов или пользователя с ролью с индивидуальными настройками. |
| X-Auth-Password (required) | Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора курсов или пользователя с ролью с индивидуальными настройками. |
Заголовки ответа
| Заголовок | Описание |
|---|---|
| modules | Массив со списком модулей курса. |
| module | Массив с данными о модуле курса. |
| moduleId | ID модуля курса. |
| itemId | ID материала или мероприятия, входящих в состав курса. Этот параметр указывает на ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с параметром moduleId. |
| courseId | ID курса, в который входит модуль. |
| title | Название модуля курса. |
| description | Описание модуля курса. |
| authorId | ID автора материала (есть в ответе, только если type = material). |
| addedDate | Дата создания материала или мероприятия, входящих в состав курса. |
| viewUrl | Ссылка на просмотр материала курса (есть в ответе, только если type = material). |
| type | Тип модуля курса.
|
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | OK | Запрос успешно обработан. |
| 404 | Unknown content item | Не найден курс с указанным ID. |
| 403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
GET /course/2a06bb18-41a1-11ea-b641-0a580af40727/modules https/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-Email: email@email.ru X-Auth-Password: password
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <response> <learningTrackCourse> <learningTrackId>f51b20a6-828a-11ec-85ab-0242ac120038</learningTrackId> <courseId>798851ec-1625-11ec-8dfd-0242ac160034</courseId> </learningTrackCourse> <learningTrackCourse> <learningTrackId>f51b20a6-828a-11ec-85ab-0242ac120038</learningTrackId> <courseId>a19861ee-0a37-11ec-bf16-0242ac140033</courseId> </learningTrackCourse> <learningTrackCourse> <learningTrackId>ae804458-9c77-11ec-afb4-0242ac190026</learningTrackId> <courseId>a2239d7c-0a37-11ec-b63a-0242ac140033</courseId> </learningTrackCourse> <learningTrackCourse> <learningTrackId>ae804458-9c77-11ec-afb4-0242ac190026</learningTrackId> <courseId>a1c8afde-0a37-11ec-b484-0242ac140033</courseId> </learningTrackCourse> <learningTrackCourse> <learningTrackId>ae804458-9c77-11ec-afb4-0242ac190026</learningTrackId> <courseId>a19861ee-0a37-11ec-bf16-0242ac140033</courseId> </learningTrackCourse> </response>