Документация по iSpring Learn

Дерево страниц

Сравнение версий

Старая версия 11

changes.mady.by.user admin

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user Алина Задина

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Включить страницу
Лэйблы с указанием тарифа
Лэйблы с указанием тарифа

Запрос: 

...

GET \course/{id}/modules

Информация

Важно:

  • C помощью метода вы можете получить список модулей курса (материалов и мероприятий), входящих в состав одного курса).

Оглавление
minLevel2

Права пользователя для выполнения запроса 

Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор курсов или роль с индивидуальными настройками и Автор курсов, у которого есть доступ к проекту, где находится этот курс.

Заголовки

...

запроса

Параметр id в запросе — ID курса, список модулей которого вы хотите получить.

Заголовок

Описание

X-Auth-Account-Url (required)Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru.X-Auth-Email (required)Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора курсов или пользователя с ролью с индивидуальными настройками.X-Auth-Password (required)Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора курсов или пользователя с ролью с индивидуальными настройками.

Заголовки ответа

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса

Параметры ответа

Параметры
Заголовок
Описание
modulesМассив со списком модулей курса
. 
moduleМассив с данными о модуле курса
.
moduleIdID модуля курса
.
itemIdID
модуля курса.
материала или мероприятия, входящих в состав курса. 
Этот параметр указывает на ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с параметром moduleId
courseIdID курса, в который входит
модуля курса.
модуль
titleНазвание модуля курса
.
descriptionОписание модуля курса
.
authorIdID автора
или создателя модуля курса.
материала (есть в ответе, только если type = material)
addedDateДата
добавления или создания модуля курса.
создания материала или мероприятия, входящих в состав курса
viewUrlСсылка на просмотр
модуля курса.
материала курса (есть в ответе, только если type = material)
type

Тип модуля курса

: материал или мероприятие.

.
Возможные значения:

  • material
  • training
sequentialNumber

Порядковый номер модуля в курсе

Коды ответов

Код

Текст

Описание

200
Ok
OKЗапрос успешно обработан
.
404Unknown content itemНе найден курс с указанным ID
.
403Permission deniedУ пользователя недостаточно прав для выполнения запроса
.

Пример запроса

Блок кода
languagexml
GET /course/2a06bb18a849d840-41a16a8a-11ea11ef-b641b992-0a580af4072736bad3a603e7/modules httpsHTTP/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-UrlAccept: https://myaccount.ispringlearn.ru
X-Auth-Email: email@email.ru
X-Auth-Password: passwordapplication/json
Authorization: gsTy154jePghm1yDv4scE9gKzqrjI8MXCXr4Yg4kz5A

Пример ответа

Блок кода
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<response>{

    <modules>"modules": [
        <module>{
             <moduleId>37cb8634-41a1-11ea-9240-0a580af40727</moduleId>"moduleId": "ec712528-6a8a-11ef-8749-be6337f13907",
            <itemId>c74a3bc3-f593-11e9-a66a-0a580af40186</itemId>"itemId": "ec5e8328-6a8a-11ef-9bd7-36bad3a603e7",
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>"courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7",
            <title>Профессиональные продажи автомобилей</title>
"title": "Задание",
             <description></description>"description": "Задание для стажёров",
            <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
"authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2",
             <addedDate>2020-01-28T07:38:46+00:00</addedDate>"addedDate": "2024-09-04T06:57:17+00:00",
            <type>material</type> "type": "material",
            <viewUrl>https"viewUrl": "https://myaccountcourses.ispringlearn.ru/view/1235050-FGwkMKHrJL-0toYx-GP6Fz</viewUrl>
8FRvR-hmBHP",
         </module>
   "sequentialNumber": 1
    <module>
    },
        <moduleId>4772dd8a-41a1-11ea-bfc8-0a580af40727</moduleId>
{
             <itemId>f75a3bc3-f593-11e9-a66a-0a580af40197</itemId>"moduleId": "0e028092-6a9a-11ef-b60f-c298d4afc52f",
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId> "itemId": "0dd3d554-6a9a-11ef-b4ad-723c165888c7",
            <title>Как повысить продажи за 7 дней</title>
            <description></description>
            <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>"courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7",
            <addedDate>2020-01-28T07:39:13+00:00</addedDate>
            <type>material</type>"title": "Тест",
            <viewUrl>https://myaccount.ispringlearn.ru/view/12-BJRXd-hbzrL-19ubg</viewUrl>
        </module>"description": "Итоговое тестирование",
        <module>
            <moduleId>47778f92-41a1-11ea-a4c8-0a580af40727</moduleId>"authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2",
            <itemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</itemId> "addedDate": "2024-09-04T08:45:36+00:00",
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>"type": "material",
            <title>Видеокурс по прямым продажам</title>
            <description></description>
            <addedDate>2020-01-28T07:39:13+00:00</addedDate>"viewUrl": "https://courses.ispringlearn.ru/view/35050-AcGpe-PFf7E-eBzuw",
            <type>training</type>
        </module>"sequentialNumber": 2
        ...    }
    </modules>
</response>]
}