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

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

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 13 Следующий »

Метод: ListCourseModules

Важно:

  • C помощью метода вы можете получить список модулей (материалов и мероприятий), входящих в состав одного курса.

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

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

Параметры

Параметр

Тип

Описание

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

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

ЗаголовокТипОписание
modulesarrayМассив со списком модулей курса.
modulearrayМассив с данными о модуле курса.
moduleIdstringID модуля курса.
itemIdstringID материала или мероприятия, входящего в состав курса. 
Этот параметр указывает на ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с параметром moduleId.
courseIdstringID курса, в который входит модуль.
titlestringНазвание модуля курса.
descriptionstringОписание модуля курса.
authorIdstringID автора материала (есть в ответе, только если type = material).
addedDatedateTimeДата добавления или создания модуля курса.
viewUrlstringСсылка на просмотр материала курса (есть в ответе, только если type = material).
type stringТип модуля курса: материал или мероприятие.
Возможные значения:
  • material
  • training
trainingType[trainingTypeId],
trainingType[trainingTypeTitle]		stringОбъект тип тренинга (есть в ответе, только если type = training), который включает в себя ID  и заголовок .
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>
      <ListCourseModulesRequest>
         <credentials>
            <accountUrl>https://myaccount.ispringlearn.ru</accountUrl>
            <email>owner</email>
            <password>******</password>
         </credentials>
         <courseId>
                   <id>296773a6-4196-11ea-bc3a-0a580af40727</id>
         </courseId>
          <pageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</pageToken>
          <pageSize>5</pageSize>
      </ListCourseModulesRequest>
  </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>
      <ListCourseModulesResult>
         <modules>
            <module>
               <moduleId>627313fa-4199-11ea-9802-0a580af40727</moduleId>
               <itemId>c74a3bc3-f593-11e9-a66a-0a580af40186</itemId>
               <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>
               <type>material</type>
            </module>
            <module>
               <moduleId>8d4a3c60-419a-11ea-8b48-0a580af40727</moduleId>
               <itemId>f75a3bc3-f593-11e9-a66a-0a580af40197</itemId>
               <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>
               <type>material</type>
            </module>
            <module>
               <moduleId>9737a690-419a-11ea-89bd-0a580af40727</moduleId>
               <itemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</itemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>Продажи в автосалоне</title>
               <description/>
               <addedDate>2020-01-28T06:51:23+00:00</addedDate>
               <type>training</type>  
                  <trainingType>
                  <trainingTypeId>31ab90b9-1098-11ec-9c51-0242ac1d0008</trainingTypeId>
                  <trainingTypeTitle>meeting</trainingTypeTitle>
               </trainingType>
               <trainingType>
                  <trainingTypeId>31ab90b9-1098-11ec-9c51-0242ac1d0008</trainingTypeId>
                  <trainingTypeTitle>meeting</trainingTypeTitle>
                </trainingType>
            </module>
                 ....
         </modules>
         <nextPageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</nextPageToken>
      </ListCourseModulesResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • Нет меток