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

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

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

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

changes.mady.by.user admin

Сохранено

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

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

changes.mady.by.user Алина Задина

Сохранено

Ключ

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

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

Метод: listContent

Информация

Важно:

  1. Запрос используется для получения списка контента частями. Это удобно, если в аккаунте тысячи позиций контента.

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

  3. В ответе будут содержаться только оригинальные (изначально созданные или загруженные) версии курсов и материалов. 

    Допустим, при создании курса Б вы скопировали тест из курса А. В ответ будет включен только исходный тест из курса А.

    Еще один пример. Курс добавили в траекторию обучения. В ответ попадет только оригинальный курс, а его копия в составе траектории обучения — нет.

  4. Узнайте, как получить список материалов курсов аккаунта, в статье Получение списка материалов курса.

Параметры

.. 

Параметр

Тип

Описание

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

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

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

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

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

Возвращает массив данных со следующими свойствами:

Информация

Для роли с индивидуальными настройками разрешите «Просмотр и назначение материалов пользователям».

Image Added

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

ЗаголовокТипОписание
contentItemsarrayМассив со списком курсов, траекторий обучения или материалов, загруженных в аккаунт вне курса
contentItemarrayМассив с данными о курсе, траектории обучения или материале, который был загружен в аккаунт вне курса
contentItemIdstringID курса, траектории обучения или материала, который был загружен в аккаунт вне курса
titlestringНазвание курса, траектории обучения или материала, который был загружен в аккаунт вне курса
subtitlestringПодзаголовок курса, траектории обучения или материала, который был загружен в аккаунт вне курса
descriptionstringОписание курса, траектории обучения или материала, который был загружен в аккаунт вне курса
ПараметрТипОписание
userIdstringID
выбранного пользователя.statusstringТекстовый статус по курсу для данного пользователя.progressfloatПрогресс выполнения курса пользователем.nextPageTokenstringТокен для перехода на следующую страницу. 
пользователя, который создал контент
addedDatedateTimeДата добавления курса, траектории обучения или материала, который был загружен в аккаунт вне курса
viewUrlstringСсылка на просмотр курса, траектории обучения или материала, который был загружен в аккаунт вне курса
typestringТип контента
nextPageTokenstringКлюч к следующей странице с контентом

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

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

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

Блок кода
languagexml
<soapenv:Envelope xmlns:soapenv="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="httphttps://ispringlearn.com/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ListContentRequest>
         <soap:credentials>
                 <soap:accountUrl>http://myaccount.ispringlearn.ru<<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:accountUrl>token>
              <soap:email>http://myaccount.ispringlearn.ru</soap:email>
            <soap:password>password</soap:password>
         </soap:   </soap:credentials>
         <soap:pageToken>string</soap:pageToken>
         <soap:pageSize>1000</soap:pageSize>
      </soap:ListContentRequest>
   </soapenv:Body>
</soapenv:Envelope>

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

Блок кода
languagexml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="httphttps://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ns1:ListContentResult>
         <ns1:contentItems>
            <ns1:contentItem>
               <ns1:contentItemId>string</ns1:contentItemId>
               <ns1:title>string<title>Адаптация отдела продаж</ns1:title>
               <ns1:description/>subtitle>Развитие мягких навыков</ns1:title>
               <ns1:description>Курс для стажеров отдела продаж.<ns1:description/>  
               <ns1:userId>string</ns1:userId>
               <ns1:addedDate>2019-11-13T06:30:49+00:00</ns1:addedDate>
               <ns1:viewUrl>string</ns1:viewUrl>
               <ns1:type>string</ns1:type>
            </ns1:contentItem>
            <ns1:contentItem>
              ...
            </ns1:contentItem>
         </ns1:contentItems>
         <ns1:nextPageToken>string</ns1:nextPageToken>
      </ns1:ListContentResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

...