Метод: ListCourseModules
Важно:
- C помощью метода вы можете получить список модулей (материалов и мероприятий), входящих в состав одного курса.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения, Автор курсов или роль с индивидуальными настройками.
Параметры
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
courseId (обязательный) | string | ID курса. |
pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | string | Токен для перехода на следующую страницу. |
Возвращаемые значения
Заголовок | Тип | Описание |
---|---|---|
modules | array | Массив со списком модулей курса. |
module | array | Массив с данными о модуле курса. |
moduleId | string | ID модуля курса. |
itemId | string | ID модуля курса. |
courseId | string | ID курса, в который входит модуль. |
title | string | Название модуля курса. |
description | string | Описание модуля курса. |
authorId | string | ID автора материала (есть в ответе, только если type = material). |
addedDate | dateTime | Дата добавления или создания модуля курса. |
viewUrl | string | Ссылка на просмотр материала курса (есть в ответе, только если type = material). |
type | 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> <ListCourseModulesRequest> <credentials> <accountUrl>https://myaccount.ispringlearn.ru</accountUrl> <email>owner</email> <password>******</password> </credentials> <courseId> <id>296773a6-4196-11ea-bc3a-0a580af40727</id> </courseId> <pageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</pageToken> <pageSize>5</pageSize> </ListCourseModulesRequest> </SOAP-ENV:Body> </SOAP-ENV: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> <ListCourseModulesResult> <modules> <module> <moduleId>627313fa-4199-11ea-9802-0a580af40727</moduleId> <itemId>c74a3bc3-f593-11e9-a66a-0a580af40186</itemId> <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId> <title>Список обязательной литературы для отдела продаж</title> <description/> <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId> <addedDate>2020-01-28T06:18:56+00:00</addedDate> <viewUrl>https://myaccount.ispringlearn.ru/view/12-LBnDw-JYb9W-7RZCU</viewUrl> <type>material</type> </module> <module> <moduleId>8d4a3c60-419a-11ea-8b48-0a580af40727</moduleId> <itemId>f75a3bc3-f593-11e9-a66a-0a580af40197</itemId> <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId> <title>Метод SPIN-продаж</title> <description/> <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId> <addedDate>2020-01-28T06:51:05+00:00</addedDate> <viewUrl>https://myaccount.ispringlearn.ru/view/12-FHLn3-9VcLv-ML2gM</viewUrl> <type>material</type> </module> <module> <moduleId>9737a690-419a-11ea-89bd-0a580af40727</moduleId> <itemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</itemId> <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId> <title>Продажи в автосалоне</title> <description/> <addedDate>2020-01-28T06:51:23+00:00</addedDate> <type>training</type> </module> .... </modules> <nextPageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</nextPageToken> </ListCourseModulesResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>