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

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

ДОСТУПНО В BUSINESS ПОДПИСКЕ

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

Важно:

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

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

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

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

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

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

Заголовок

Описание

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
courseIds (необязательный)ID курсов, список материалов которых вы хотите получить
pageSize (необязательный)Количество записей на 1 страницу. Если параметр не указан, то 1000
pageToken (необязательный)Токен для перехода на следующую страницу

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

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

Коды ответов

Код

Текст

Описание

200OКЗапрос успешно обработан
400Bad requestОшибка в запросе
401UnauthorizedОшибка авторизации
403Permission deniedУ пользователя недостаточно прав для выполнения запроса

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

GET/courses/modules?courseIds[]=2a06bb18-41a1-11ea-b641-0a580af40727&pageSize=1000&pageToken=Mg https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

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

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

<?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>
  • Нет меток