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

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

Ключ

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

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

Запрос: 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 материала
ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с
параметром moduleId.
параметром moduleId
courseIdID курса, в который входит модуль
.
titleНазвание модуля курса
.
descriptionОписание модуля курса
.
authorIdID автора материала (есть в ответе, только если type = material)
.
addedDateДата создания материала или мероприятия, входящих в состав курса
.
viewUrlСсылка на просмотр материала курса (есть в ответе, только если type = material)
.
type

Тип модуля курса.
Возможные значения:

  • material
  • training
sequentialNumber

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

Коды ответов

Код

Текст

Описание

200OKЗапрос успешно обработан
.
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>
    <learningTrackCourse>
        <learningTrackId>f51b20a6-828a-11ec-85ab-0242ac120038</learningTrackId>
        <courseId>798851ec-1625-11ec-8dfd-0242ac160034</courseId>
    </learningTrackCourse>
    <learningTrackCourse>
        <learningTrackId>f51b20a6-828a-11ec-85ab-0242ac120038</learningTrackId>
        <courseId>a19861ee-0a37-11ec-bf16-0242ac140033</courseId>
    </learningTrackCourse>
    <learningTrackCourse>
        <learningTrackId>ae804458-9c77-11ec-afb4-0242ac190026</learningTrackId>
        <courseId>a2239d7c-0a37-11ec-b63a-0242ac140033</courseId>
    </learningTrackCourse>
    <learningTrackCourse>
        <learningTrackId>ae804458-9c77-11ec-afb4-0242ac190026</learningTrackId>
        <courseId>a1c8afde-0a37-11ec-b484-0242ac140033</courseId>
    </learningTrackCourse>
    <learningTrackCourse>
        <learningTrackId>ae804458-9c77-11ec-afb4-0242ac190026</learningTrackId>
        <courseId>a19861ee-0a37-11ec-bf16-0242ac140033</courseId>
    </learningTrackCourse>
</response>{

    "modules": [
        {
            "moduleId": "ec712528-6a8a-11ef-8749-be6337f13907",
            "itemId": "ec5e8328-6a8a-11ef-9bd7-36bad3a603e7",
            "courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7",
            "title": "Задание",
            "description": "Задание для стажёров",
            "authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2",
            "addedDate": "2024-09-04T06:57:17+00:00",
            "type": "material",
            "viewUrl": "https://courses.ispringlearn.ru/view/35050-KHrJL-8FRvR-hmBHP",
            "sequentialNumber": 1
        },
        {
            "moduleId": "0e028092-6a9a-11ef-b60f-c298d4afc52f",
            "itemId": "0dd3d554-6a9a-11ef-b4ad-723c165888c7",
            "courseId": "a849d840-6a8a-11ef-b992-36bad3a603e7",
            "title": "Тест",
            "description": "Итоговое тестирование",
            "authorId": "ec8f0c3e-6443-11ef-bd38-42a2a95d78c2",
            "addedDate": "2024-09-04T08:45:36+00:00",
            "type": "material",
            "viewUrl": "https://courses.ispringlearn.ru/view/35050-AcGpe-PFf7E-eBzuw",
            "sequentialNumber": 2
        }
    ]
}