ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: GET /contents
Важно:
- Запрос используется для получения списка контента частями. Это удобно, если в аккаунте тысячи позиций контента.
- Вы получите список всего контента, доступного в аккаунте — траекторий обучения, курсов, отдельно загруженных материалов, материалов, входящих в состав курса.
- В ответе будут содержаться только оригинальные (изначально созданные или загруженные) версии курсов и материалов.
Допустим, при создании курса Б вы создали связанную копию теста из курса А. В ответ будет включен только исходный тест из курса А.
Еще один пример. Курс добавили в траекторию обучения. В ответ попадет только оригинальный курс, а его копия в составе траектории обучения — нет. - Узнайте, как получить список материалов курсов аккаунта, в статье Получение списка материалов курса (устаревший).
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, роль с индивидуальными настройками и Автор курсов, у которых есть доступ к проекту, где находятся курсы.
Для роли с индивидуальными настройками разрешите «Просмотр и назначение материалов пользователям».
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса. |
Параметр | Описание |
pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000 |
pageToken (необязательный) | Токен для перехода на следующую страницу |
Заголовки и параметры ответа
Заголовок | Описание |
---|---|
contentItems | Массив со списком курсов, траекторий обучения или материалов, загруженных в аккаунт вне курса |
contentItem | Массив с данными о курсе, траектории обучения или материале, который был загружен в аккаунт вне курса |
contentItemId | ID курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
title | Название курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
subtitle | Подзаголовок курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
description | Описание курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
userId | ID пользователя, кому назначен курс, траектория обучения или материал, который был загружен в аккаунт вне курса |
addedDate | Дата добавления курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
viewUrl | Ссылка на просмотр курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
type | Тип контента |
nextPageToken | Ключ к следующей странице с контентом |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | OK | Запрос успешно обработан |
404 | Unknown content item | Не найден курс с указанным ID |
403 | Permission denied | У пользователя недостаточно прав для выполнения запроса |
Возвращаемые значения
После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
nextPageToken | string | Токен для перехода на следующую страницу |
Пример запроса
GET/contents?pageSize=1000&pageToken=Mg https/1.1 Host: api-learn.ispringlearn.ru Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Пример ответа
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>Развитие мягких навыков</subtitle> <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>