Запрос: GET v2/courses/modules
Информация |
---|
Важно:
|
...
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор курсов или роль с индивидуальными настройками.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
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 | Массив с данными о материале или мероприятии. |
moduleId | ID материала или мероприятия. |
contentItemId | ID материала или мероприятия. |
courseId | ID курса, в который входит материал или мероприятие. |
title | Название материала или мероприятия. |
description | Описание материала или мероприятия. |
authorId | ID автора материала или создателя мероприятия. |
addedDate | Дата добавления материала или создания мероприятия. |
viewUrl | Ссылка на просмотр материала или мероприятия. |
nextPageToken | Ключ к следующей странице списка материалов и мероприятий. |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | Ok | Запрос успешно обработан. |
404 | Unknown content item | Не найден курс с указанным ID. |
403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
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 |
...