...
Параметры
Параметр | Тип | Описание | |
|---|---|---|---|
| credentials token (обязательный) | credentials | string | Токен доступа. Вы можете получить токен с помощью запросаСмотрите описание объекта Credentials. |
| courseId (обязательный) | string | ID курса. | |
| pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000 | .|
| pageToken (необязательный) | string | Токен для перехода на следующую страницу | .
Возвращаемые значения
| Заголовок | Тип | Описание | |||
|---|---|---|---|---|---|
| modules | array | Массив со списком модулей курса. | |||
| module | array | Массив с данными о модуле курса | .|||
| moduleId | string | ID модуля курса. | |||
| itemId | string | ID материала или мероприятия, входящего в состав курса. Этот | параметр указывает параметр указывает на | ID материалаID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с | параметром moduleId.параметром 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 | Токен для перехода на следующую страницу | .|||
| sequentialNumber | string | Порядковый номер модуля в курсе |
Возможные ошибки
| Ошибка | Описание |
|---|---|
| Unknown content item | Не найден курс с указанным ID |
| Permission denied | У пользователя недостаточно прав для выполнения запроса |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV<soapenv:Envelope xmlns:SOAP-ENVsoapenv="httpshttp://schemas.xmlsoap.org/soap/envelope/" xmlns="httpsxmlns:soap="http://ispringlearn.comru/go/services/api/soap"> <SOAP-ENV:Body> <Header <soapenv:Header/> <Body><soapenv:Body> <ListCourseModulesRequest><soap:ListCourseModulesRequest> <credentials><soap:credentials> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials><soap:token>K8yyVyTp3Zhe_IUqAnKSVLGzHtZdq5ixuCl94yWSxfE</soap:token> <courseId></soap:credentials> <soap:courseId>a849d840-6a8a-11ef-b992-36bad3a603e7</soap:courseId> <id>296773a6<!-4196-11eaOptional:-bc3a-0a580af40727</id> > <!-- <soap:pageToken>?</courseId>soap:pageToken> --> <pageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</pageToken> <!--Optional:--> <!-- <pageSize>5</pageSize><soap:pageSize>?</soap:pageSize> --> </soap:ListCourseModulesRequest> </SOAP-ENVsoapenv:Body> </SOAP-ENVsoapenv:Envelope> |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
<SOAP-ENV:Envelope xmlns:SOAP-ENV="httpshttp://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="httpshttp://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ListCourseModulesResult><ns1:ListCourseModulesResult> <modules><ns1:modules> <module><ns1:module> <moduleId>627313fa<ns1:moduleId>ec712528-41996a8a-11ea11ef-98028749-0a580af40727<be6337f13907</ns1:moduleId> <itemId>c74a3bc3<ns1:itemId>ec5e8328-f5936a8a-11e911ef-a66a9bd7-0a580af40186<36bad3a603e7</ns1:itemId> <courseId>296773a6<ns1:courseId>a849d840-41966a8a-11ea11ef-bc3ab992-0a580af40727<36bad3a603e7</ns1:courseId> <title>Список обязательной литературы для отдела продаж</title> <ns1:title>Задание</ns1:title> <ns1:description>Задание для <descriptionстажёров</>ns1:description> <authorId>79e44d4a<ns1:authorId>ec8f0c3e-07996443-11ea11ef-bb8fbd38-0a580af405bb<42a2a95d78c2</ns1:authorId> <addedDate>2020<ns1:addedDate>2024-0109-28T0604T06:1857:5617+00:00</ns1:addedDate> <viewUrl>https<ns1:viewUrl>https://myaccountcourses.ispringlearn.ru/view/1235050-LBnDwKHrJL-JYb9W8FRvR-7RZCU<hmBHP</ns1:viewUrl> <type>material<<ns1:type>material</ns1:type> </module> <module> <moduleId>8d4a3c60-419a-11ea-8b48-0a580af40727</moduleId><ns1:trainingType/> <itemId>f75a3bc3-f593-11e9-a66a-0a580af40197</itemId><ns1:sequentialNumber>1</ns1:sequentialNumber> <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId></ns1:module> <title>Метод SPIN-продаж</title><ns1:module> <description/> <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId><ns1:moduleId>0e028092-6a9a-11ef-b60f-c298d4afc52f</ns1:moduleId> <addedDate>2020-01-28T06:51:05+00:00</addedDate><ns1:itemId>0dd3d554-6a9a-11ef-b4ad-723c165888c7</ns1:itemId> <viewUrl>https://myaccount.ispringlearn.ru/view/12-FHLn3-9VcLv-ML2gM</viewUrl><ns1:courseId>a849d840-6a8a-11ef-b992-36bad3a603e7</ns1:courseId> <type>material</type> </module><ns1:title>Тест</ns1:title> <module> <moduleId>9737a690-419a-11ea-89bd-0a580af40727</moduleId><ns1:description>Итоговое тестирование</ns1:description> <itemId>f75a3bc3<ns1:authorId>ec8f0c3e-f5846443-11e911ef-a66abd38-0a580a1bf40197<42a2a95d78c2</itemId>ns1:authorId> <courseId>296773a6<ns1:addedDate>2024-4196-11ea-bc3a-0a580af40727</courseId> <title>Продажи в автосалоне</title> <description/> <addedDate>2020-01-28T06:51:2309-04T08:45:36+00:00</ns1:addedDate> <type>training</type> <ns1:viewUrl>https://courses.ispringlearn.ru/view/35050-AcGpe-PFf7E-eBzuw</ns1:viewUrl> <trainingType> <trainingTypeId>31ab90b9-1098-11ec-9c51-0242ac1d0008</trainingTypeId><ns1:type>material</ns1:type> <trainingTypeTitle>meeting</trainingTypeTitle><ns1:trainingType/> </trainingType><ns1:sequentialNumber>2</ns1:sequentialNumber> </ns1:module> .... </modules> <nextPageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</nextPageToken>ns1:modules> </ns1:ListCourseModulesResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...