Запрос: GET /contents
Важно:
- Запрос используется для получения списка контента частями. Это удобно, если в аккаунте тысячи позиций контента.
- Вы получите список всего контента, доступного в аккаунте — траекторий обучения, курсов, отдельно загруженных материалов, материалов, входящих в состав курса.
- В ответе будут содержаться только оригинальные (изначально созданные или загруженные) версии курсов и материалов.
Допустим, при создании курса Б вы скопировали тест из курса А. В ответ будет включен только исходный тест из курса А.
Еще один пример. Курс добавили в траекторию обучения. В ответ попадет только оригинальный курс, а его копия в составе траектории обучения — нет. - Узнайте, как получить список материалов курсов аккаунта, в статье Получение списка материалов курса.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения и Автор или пользователь с ролью с индивидуальными настройками могут получить данные только по пользователям подразделений, которыми управляют, и их дочерних подразделений.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
X-Auth-Account-Url (required) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru. |
X-Auth-Email (required) | Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
X-Auth-Password (required) | Пароль Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
Параметр | Описание |
pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | Токен для перехода на следующую страницу. |
Заголовки ответа
Заголовок | Описание |
---|---|
contentItems | Массив со списком курсов, траекторий обучения или материалов, загруженных в аккаунт вне курса. |
contentItem | Массив с данными о курсе, траектории обучения или материале, который был загружен в аккаунт вне курса. |
contentItemId | ID курса, траектории обучения или материала, который был загружен в аккаунт вне курса. |
title | Название курса, траектории обучения или материала, который был загружен в аккаунт вне курса. |
description | Описание курса, траектории обучения или материала, который был загружен в аккаунт вне курса. |
userId | ID пользователя, кому назначен курс, траектория обучения или материал, который был загружен в аккаунт вне курса. |
addedDate | Дата добавления курса, траектории обучения или материала, который был загружен в аккаунт вне курса. |
viewUrl | Ссылка на просмотр курса, траектории обучения или материала, который был загружен в аккаунт вне курса. |
type | Тип контента. |
nextPageToken | Ключ к следующей странице с контентом. |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | Ok | Запрос успешно обработан. |
404 | Unknown content item | Не найден курс с указанным ID. |
403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
GET/contents?pageSize=1000&pageToken=Mg HTTP/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
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <response> <contentItems> <contentItem> <contentItemId>c74a3bc3-f593-11e9-a66a-0a580af40186</contentItemId> <title>string</title> <description>string</description> <userId>b6981094-f593-11e9-a66a-0a580af40186</userId> <addedDate>2016-10-24T11:18:23+00:00</addedDate> <viewUrl>http://myaccount.ispringlearn.ru/view/22751-AE13s-h3T3K-ViCzL</viewUrl> <type>Курс</type> </contentItem> <contentItem> ... </contentItem> </contentItems> <nextPageToken>string</nextPageToken> </response>