Информация |
---|
Важно:
- C помощью метода вы можете получить список материалов и мероприятий, входящих в состав одного курса.
|
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения, Автор или роль с индивидуальными настройками.
Параметры
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
contentItemId (обязательный) | string | ID курса. |
pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | string | Токен для перехода на следующую страницу. |
Возвращаемые значения
Заголовок | Тип | Описание |
---|
modules | array | Массив со списком материалов всех курсов аккаунта или определенных курсов. |
module | array | Массив с данными о материале. |
moduleId | string | ID материала. |
contentItemId | string | ID материала. |
courseId | string | ID курса, в который входит материал. |
title | string | Название материала. |
description | string | Описание материала. |
authorId | string | ID автора материала. |
addedDate | dateTime | Дата добавления материала. |
viewUrl | string | Ссылка на просмотр материала. |
nextPageToken | string | Ключ к следующей странице списка материалов. |
Возможные ошибки
Ошибка | Описание |
---|
Unknown content item | Не найден курс с указанным ID. |
Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
Блок кода |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<Header/>
<Body>
<ListCoursesModulesRequest>
<credentials>
<accountUrl>https://myaccount.ispringlearn.ru</accountUrl>
<email>owner</email>
<password>******</password>
</credentials>
<courseIds>
<id>296773a6-4196-11ea-bc3a-0a580af40727</id>
</courseIds>
<pageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</pageToken>
<pageSize>5</pageSize>
</ListCoursesModulesRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
...