Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Запрос: GET v2/courses/modules

Информация

Важно:

  • C помощью метода Получение списка материалов курса вы метода вы можете получить список материалов и мероприятий по всем курсам аккаунта или указать курсы, список материалов и мероприятий, которых желаете получить. 

...

Владелец аккаунтаАдминистратор аккаунтаАдминистратор подразделения, Автор курсов или роль с индивидуальными настройками.

Заголовки и параметры запроса

Заголовок

Описание

X-Auth-Account-Url (required)Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru.
X-Auth-Email (required)Логин Владельца аккаунтаАдминистратора аккаунтаАдминистратора подразделения, 
Автора 
Автора курсов или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (required)Пароль Владельца аккаунтаАдминистратора аккаунтаАдминистратора подразделения,
 Автора 
 Автора курсов или пользователя с ролью с индивидуальными настройками.
ПараметрОписание
courseIds (необязательный)ID курсов, список материалов и мероприятий, которых вы хотите получить.
pageSize (необязательный)Количество записей на 1 страницу. Если не указан, то 1000.
pageToken (необязательный)Токен для перехода на следующую страницу. 

Заголовки ответа

ЗаголовокОписание
modulesМассив со списком материалов и мероприятий всех курсов аккаунта или определенных курсов. 
moduleМассив с данными о материале или мероприятии.
moduleIdID материала или мероприятия.
contentItemIdID материала или мероприятия.
courseIdID курса, в который входит материал или мероприятие.
titleНазвание материала или мероприятия.
descriptionОписание материала или мероприятия.
authorIdID автора материала или создателя мероприятия.
addedDateДата добавления материала или создания мероприятия.
viewUrlСсылка на просмотр материала или мероприятия.
nextPageTokenКлюч к следующей странице списка материалов и мероприятий.

Коды ответов

Код

Текст

Описание

200OkЗапрос успешно обработан.
404Unknown content itemНе найден курс с указанным ID.
403Permission deniedУ пользователя недостаточно прав для выполнения запроса.

Пример запроса

Блок кода
languagexml
GET v2/courses/modules?courseIds[]=2a06bb18-41a1-11ea-b641-0a580af40727&pageSize=1000&pageToken=Mg 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

...