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

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

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

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

changes.mady.by.user admin

Сохранено

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

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

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

Сохранено

Ключ

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

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

Запрос

Запрос: 

GET /contents

Информация

Параметры запроса

Важно:

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

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

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

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

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

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

Оглавление
minLevel2

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

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

Информация

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

Image Added

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

ЗаголовокОписание
Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
pageSize (необязательный)
ПараметрОписаниеX-Auth-Account-Url (required)Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru.X-Auth-Email (required)Логин Владельца аккаунта, Администратора, Администратора подразделения или Автора.X-Auth-Password (required)Пароль Владельца аккаунта, Администратора, Администратора подразделения или Автора.pageSize
Количество записей на 1 страницу. Если не указан, то 1000
.
pageToken (необязательный)Токен для перехода на следующую страницу
. 

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

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

...

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

ЗаголовокОписание
contentItemsМассив со списком курсов, траекторий обучения или материалов, загруженных в аккаунт вне курса
contentItemМассив с данными о курсе, траектории обучения или материале, который был загружен в аккаунт вне курса
contentItemIdID курса, траектории обучения или материала, который был загружен в аккаунт вне курса
titleНазвание курса, траектории обучения или материала, который был загружен в аккаунт вне курса
subtitleПодзаголовок курса, траектории обучения или материала, который был загружен в аккаунт вне курса
descriptionОписание курса, траектории обучения или материала, который был загружен в аккаунт вне курса
userIdID пользователя, который создал контент
addedDateДата добавления курса, траектории обучения или материала, который был загружен в аккаунт вне курса
viewUrlСсылка на просмотр курса, траектории обучения или материала, который был загружен в аккаунт вне курса
typeТип контента
nextPageTokenКлюч к следующей странице с контентом

Коды ответов

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

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

После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:

ПараметрТипОписание
nextPageTokenstringТокен для перехода на следующую страницу

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

Блок кода
languagexml
GET/contents?pageSize=1000&pageToken=Mg HTTPhttps/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: http://myaccount.ispringlearn.ru
X-Auth-Email: email@email.com
X-Auth-Password: password
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

Блок кода
languagexml
https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<statuses>
<response>
    <contentItems>
     <status>
   <contentItem>
           <userId>43f4a84c <contentItemId>c74a3bc3-6280f593-11e9-8686-a6210366ac32</userId>a66a-0a580af40186</contentItemId>
            <title>Адаптация отдела продаж</title>
            <subtitle>Развитие мягких <status>Пройден<навыков</status>subtitle>
        <progress>90</progress>
    <description>Курс для стажеров отдела продаж.</description>
            <completionDate>2018-10-26T12:35:10+00:00</completionDate><userId>b6981094-f593-11e9-a66a-0a580af40186</userId>
        <lastViewDate>2018    <addedDate>2016-10-26T1224T11:3318:2123+00:00</lastViewDate>addedDate>
       </status>
     <viewUrl>https://myaccount.ispringlearn.com/view/22751-AE13s-h3T3K-ViCzL</viewUrl>
       <status>     <type>Course</type>
        <userId>edit/265f433a-6214-11e9-b9cf-7ef279cfa744</userId></contentItem>
        <status>В процессе</status>
<contentItem>
            <progress>30</progress>...
        <lastViewDate>2018-10-23T14:14:13+00:00</lastViewDate></contentItem>
    </status>/contentItems>
    <nextPageToken>string</nextPageToken>
</statuses>
Информация
Поле ’completionDate’ показывается только для пройденного материала, а ’lastViewDate’ — при наличии просмотра.
response>