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

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

Ключ

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

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

Запрос: GET /contents

Информация

Важно:

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

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

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

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

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

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

Оглавление
minLevel2

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

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

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

Информация

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

Image Added

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

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

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

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

Коды ответов

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

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

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

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

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

Блок кода
languagexml
GET/contents?pageSize=1000&pageToken=Mg https/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: https://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"?>
<response>
    <contentItems>
        <contentItem>
            <contentItemId>c74a3bc3-f593-11e9-a66a-0a580af40186</contentItemId>
            <title>Адаптация отдела продаж</title>
            <subtitle>Развитие мягких <title>string<навыков</description>subtitle>
            <description><<description>Курс для стажеров отдела продаж.</description>
            <userId>b6981094-f593-11e9-a66a-0a580af40186</userId>
            <addedDate>2016-10-24T11:18:23+00:00</addedDate>
            <viewUrl>https://myaccount.ispringlearn.com/view/22751-AE13s-h3T3K-ViCzL</viewUrl>
            <type>Course</type>
        </contentItem>
        <contentItem>
            ...
        </contentItem>
    </contentItems>
    <nextPageToken>string</nextPageToken>
</response>

...