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

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

Ключ

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

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

Информация

Важно:

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

Оглавление
minLevel2

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

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

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

Заголовок

Описание

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/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

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

Блок кода
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>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>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>https://myaccount.ispringlearn.ru/12-uXDeH-byU30-yksZ6</viewUrl>
        </module>
        ...     
    </modules>
    <nextPageToken>NDc3NzhmOTItNDFhMS0xMWVhLWE0YzgtMGE1ODBhZjQwNzI3</nextPageToken>
</response>