Запрос: GET course/{id}/modules
Важно:
- C помощью метода вы можете получить список модулей (материалов и мероприятий), входящих в состав одного курса.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор курсов или роль с индивидуальными настройками.
Заголовки запроса
Параметр 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> <modules> <module> <moduleId>37cb8634-41a1-11ea-9240-0a580af40727</moduleId> <itemId>c74a3bc3-f593-11e9-a66a-0a580af40186</itemId> <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId> <title>Профессиональные продажи автомобилей</title> <description></description> <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId> <addedDate>2020-01-28T07:38:46+00:00</addedDate> <type>material</type> <viewUrl>https://myaccount.ispringlearn.ru/view/12-FGwkM-0toYx-GP6Fz</viewUrl> </module> <module> <moduleId>4772dd8a-41a1-11ea-bfc8-0a580af40727</moduleId> <itemId>f75a3bc3-f593-11e9-a66a-0a580af40197</itemId> <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId> <title>Как повысить продажи за 7 дней</title> <description></description> <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId> <addedDate>2020-01-28T07:39:13+00:00</addedDate> <type>material</type> <viewUrl>https://myaccount.ispringlearn.ru/view/12-BJRXd-hbzrL-19ubg</viewUrl> </module> <module> <moduleId>47778f92-41a1-11ea-a4c8-0a580af40727</moduleId> <itemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</itemId> <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId> <title>Видеокурс по прямым продажам</title> <description></description> <addedDate>2020-01-28T07:39:13+00:00</addedDate> <type>training</type> </module> ... </modules> </response>