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

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

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

Метод: ListCoursesModules

Важно:

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

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

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

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

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

Параметры

Параметр

Тип

Описание

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

Возвращаемые значения

ЗаголовокТипОписание
modulesarrayМассив со списком материалов всех курсов аккаунта или определенных курсов
modulearrayМассив с данными о материале
moduleIdstringID материала
contentItemIdstringID материала
courseIdstringID курса, в который входит материал
titlestringНазвание материала
descriptionstringОписание материала
authorIdstringID автора материала
addedDatedateTimeДата создания материала
viewUrlstringСсылка на просмотр материала
nextPageTokenstringКлюч к следующей странице списка материалов

Возможные ошибки

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

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

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
   <Header/>
   <Body>
      <ListCoursesModulesRequest>
         <credentials>
           <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
         </credentials>
         <courseIds>
                   <id>296773a6-4196-11ea-bc3a-0a580af40727</id>
         </courseIds>
          <pageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</pageToken>
          <pageSize>5</pageSize>
      </ListCoursesModulesRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ListCoursesModulesResult>
         <modules>
            <module>
               <moduleId>627313fa-4199-11ea-9802-0a580af40727</moduleId>
               <contentItemId>c74a3bc3-f593-11e9-a66a-0a580af40186</contentItemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>Список обязательной литературы для отдела продаж</title>
               <description/>
               <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
               <addedDate>2020-01-28T06:18:56+00:00</addedDate>
               <viewUrl>https://myaccount.ispringlearn.ru/view/12-LBnDw-JYb9W-7RZCU</viewUrl>
            </module>
            <module>
               <moduleId>8d4a3c60-419a-11ea-8b48-0a580af40727</moduleId>
               <contentItemId>f75a3bc3-f593-11e9-a66a-0a580af40197</contentItemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>Метод SPIN-продаж</title>
               <description/>
               <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
               <addedDate>2020-01-28T06:51:05+00:00</addedDate>
               <viewUrl>https://myaccount.ispringlearn.ru/view/12-FHLn3-9VcLv-ML2gM</viewUrl>
            </module>
            <module>
               <moduleId>9737a690-419a-11ea-89bd-0a580af40727</moduleId>
               <contentItemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</contentItemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>Диалоговая симуляция: Продажи в автосалоне</title>
               <description/>
               <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
               <addedDate>2020-01-28T06:51:23+00:00</addedDate>
               <viewUrl>https://myaccount.ispringlearn.ru/view/12-S47Wh-WPPYr-9ZBES</viewUrl>
            </module>
                 ....
         </modules>
         <nextPageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</nextPageToken>
      </ListCoursesModulesResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • Нет меток