ДОСТУПНО В BUSINESS ПОДПИСКЕ
Метод: ListCourseModules
Важно:
- C помощью метода вы можете получить список модулей (материалов и мероприятий), входящих в состав одного курса.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор курсов или роль с индивидуальными настройками.
Параметры
Параметр | Тип | Описание |
---|---|---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
courseId (обязательный) | string | ID курса |
pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000 |
pageToken (необязательный) | string | Токен для перехода на следующую страницу |
Возвращаемые значения
Заголовок | Тип | Описание |
---|---|---|
modules | array | Массив со списком модулей курса |
module | array | Массив с данными о модуле курса |
moduleId | string | ID модуля курса |
itemId | string | ID материала или мероприятия, входящего в состав курса. Этот параметр указывает на ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с параметром moduleId |
courseId | string | ID курса, в который входит модуль |
title | string | Название модуля курса |
description | string | Описание модуля курса |
authorId | string | ID автора материала (есть в ответе, только если type = material) |
addedDate | dateTime | Дата добавления или создания модуля курса |
viewUrl | string | Ссылка на просмотр материала курса (есть в ответе, только если type = material) |
type | string | Тип модуля курса: материал или мероприятие. Возможные значения:
|
trainingType[trainingTypeId], trainingType[trainingTypeTitle] | string | Тип мероприятия, который включает в себя ID и заголовок. |
nextPageToken | string | Токен для перехода на следующую страницу |
Возможные ошибки
Ошибка | Описание |
---|---|
Unknown content item | Не найден курс с указанным ID |
Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.ru/go/services/api/soap"> <soapenv:Header/> <soapenv:Body> <soap:ListCourseModulesRequest> <soap:credentials> <soap:token>K8yyVyTp3Zhe_IUqAnKSVLGzHtZdq5ixuCl94yWSxfE</soap:token> </soap:credentials> <soap:courseId>a849d840-6a8a-11ef-b992-36bad3a603e7</soap:courseId> <!--Optional:--> <!-- <soap:pageToken>?</soap:pageToken> --> <!--Optional:--> <!-- <soap:pageSize>?</soap:pageSize> --> </soap:ListCourseModulesRequest> </soapenv:Body> </soapenv:Envelope>
Пример ответа
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ns1:ListCourseModulesResult> <ns1:modules> <ns1:module> <ns1:moduleId>ec712528-6a8a-11ef-8749-be6337f13907</ns1:moduleId> <ns1:itemId>ec5e8328-6a8a-11ef-9bd7-36bad3a603e7</ns1:itemId> <ns1:courseId>a849d840-6a8a-11ef-b992-36bad3a603e7</ns1:courseId> <ns1:title>Задание</ns1:title> <ns1:description>Задание для стажёров</ns1:description> <ns1:authorId>ec8f0c3e-6443-11ef-bd38-42a2a95d78c2</ns1:authorId> <ns1:addedDate>2024-09-04T06:57:17+00:00</ns1:addedDate> <ns1:viewUrl>https://courses.ispringlearn.ru/view/35050-KHrJL-8FRvR-hmBHP</ns1:viewUrl> <ns1:type>material</ns1:type> <ns1:trainingType/> <ns1:sequentialNumber>1</ns1:sequentialNumber> </ns1:module> <ns1:module> <ns1:moduleId>0e028092-6a9a-11ef-b60f-c298d4afc52f</ns1:moduleId> <ns1:itemId>0dd3d554-6a9a-11ef-b4ad-723c165888c7</ns1:itemId> <ns1:courseId>a849d840-6a8a-11ef-b992-36bad3a603e7</ns1:courseId> <ns1:title>Тест</ns1:title> <ns1:description>Итоговое тестирование</ns1:description> <ns1:authorId>ec8f0c3e-6443-11ef-bd38-42a2a95d78c2</ns1:authorId> <ns1:addedDate>2024-09-04T08:45:36+00:00</ns1:addedDate> <ns1:viewUrl>https://courses.ispringlearn.ru/view/35050-AcGpe-PFf7E-eBzuw</ns1:viewUrl> <ns1:type>material</ns1:type> <ns1:trainingType/> <ns1:sequentialNumber>2</ns1:sequentialNumber> </ns1:module> </ns1:modules> </ns1:ListCourseModulesResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>