Документация по iSpring Learn

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

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

Старая версия 13

changes.mady.by.user admin

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user elena.antipova

Сохранено

Ключ

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

Включить страницу
Лэйблы с указанием тарифа
Лэйблы с указанием тарифа

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

Информация

Важно:

  1. Сейчас курсы в iSpring Learn могут содержать не только материалы, но и мероприятия. Чтобы получить список материалов и мероприятий курса, воспользуйтесь методом Получение списка материалов и мероприятий курса.

  2. Метод Получение списка материалов курса не рекомендуется использовать, так как в ответе будут содержаться только материалы курса, без мероприятий. В будущем этот метод будет удалён.

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

...

Оглавление

...

minLevel2

Права пользователя для выполнения запроса 

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

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

... 

Заголовок

Описание

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса

Описание

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

Права пользователя для выполнения запроса 

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

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

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

Коды ответов

Код

Текст

Описание

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

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

Блок кода
languagexml
GET/courses/modules?courseIds[]=2a06bb18-41a1-11ea-b641-0a580af40727&pageSize=1000&pageToken=Mg HTTPhttps/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: http://myaccount.ispringlearn.ru
X-Auth-Email: email@email.ru
X-Auth-Password: password 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

Блок кода
languagexml
GET/courses/modules?courseIds=2a06bb18-41a1-11ea-b641-0a580af40727,a1c8afde-0a37-11ec-b484-0242ac140033&pageSize=1000&pageToken=a1c8afde-0a37-11ec-b484-0242ac140033 https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

Пример ответа

Блок кода
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <modules>
        <module>
            <moduleId>37cb8634-41a1-11ea-9240-0a580af40727</moduleId>
            <contentItemId>c74a3bc3-f593-11e9-a66a-0a580af40186</contentItemId>
            <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>
            <viewUrl>http<viewUrl>https://myaccount.ispringlearn.ru/view/12-FGwkM-0toYx-GP6Fz</viewUrl>
        </module>
        <module>
            <moduleId>4772dd8a-41a1-11ea-bfc8-0a580af40727</moduleId>
            <contentItemId>f75a3bc3-f593-11e9-a66a-0a580af40197</contentItemId>
            <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>
            <viewUrl>http<viewUrl>https://myaccount.ispringlearn.ru/view/12-BJRXd-hbzrL-19ubg</viewUrl>
        </module>
        <module>
            <moduleId>47778f92-41a1-11ea-a4c8-0a580af40727</moduleId>
            <contentItemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</contentItemId>
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>
            <title>Видеокурс по прямым продажам</title>
            <description></description>
            <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
            <addedDate>2020-01-28T07:39:13+00:00</addedDate>
            <viewUrl>http<viewUrl>https://myaccount.ispringlearn.ru/12-uXDeH-byU30-yksZ6</viewUrl>
        </module>
        ...     
    </modules>
    <nextPageToken>NDc3NzhmOTItNDFhMS0xMWVhLWE0YzgtMGE1ODBhZjQwNzI3</nextPageToken>
</response>

...