ДОСТУПНО В BUSINESS ПОДПИСКЕ
Метод: listContent
Важно:
- Запрос используется для получения списка контента частями. Это удобно, если в аккаунте тысячи позиций контента.
- Вы получите список всего контента, доступного в аккаунте — траекторий обучения, курсов, отдельно загруженных материалов, материалов, входящих в состав курса.
- В ответе будут содержаться только оригинальные (изначально созданные или загруженные) версии курсов и материалов.
Допустим, при создании курса Б вы скопировали тест из курса А. В ответ будет включен только исходный тест из курса А.
Еще один пример. Курс добавили в траекторию обучения. В ответ попадет только оригинальный курс, а его копия в составе траектории обучения — нет. - Узнайте, как получить список материалов курсов аккаунта, в статье Получение списка материалов курса.
Параметры
Параметр | Тип | Описание |
|---|---|---|
| token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
| contentItemId (обязательный) | string | ID курсов |
| pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000 |
| pageToken (необязательный) | string | Токен для перехода на следующую страницу |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор курсов или роль с индивидуальными настройками, у которых есть доступ к проекту, где находятся курсы.
Для роли с индивидуальными настройками разрешите «Просмотр и назначение материалов пользователям».
Возвращаемые значения
| Заголовок | Тип | Описание |
|---|---|---|
| contentItems | array | Массив со списком курсов, траекторий обучения или материалов, загруженных в аккаунт вне курса |
| contentItem | array | Массив с данными о курсе, траектории обучения или материале, который был загружен в аккаунт вне курса |
| contentItemId | string | ID курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
| title | string | Название курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
| subtitle | string | Подзаголовок курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
| description | string | Описание курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
| userId | string | ID пользователя, который создал контент |
| addedDate | dateTime | Дата добавления курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
| viewUrl | string | Ссылка на просмотр курса, траектории обучения или материала, который был загружен в аккаунт вне курса |
| type | string | Тип контента |
| nextPageToken | string | Ключ к следующей странице с контентом |
Возможные ошибки
| Ошибка | Описание |
|---|---|
| Unknown content item | Не найден курс с указанным ID |
| Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:ListContentRequest>
<soap:credentials>
<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
</soap:credentials>
<soap:pageToken>string</soap:pageToken>
<soap:pageSize>1000</soap:pageSize>
</soap:ListContentRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:ListContentResult>
<ns1:contentItems>
<ns1:contentItem>
<ns1:contentItemId>string</ns1:contentItemId>
<ns1:title>Адаптация отдела продаж</ns1:title>
<ns1: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>