ipr.lesson.add

Scope: ipr

Кто может вызывать: canManageCourse(courseId) или привилегированный (admin/hr). Подробнее: Модель доступа

Создаёт урок в курсе. Если landingId указан — урок создаётся из лендинг-страницы; иначе — обычный HTML-урок.

HTTP: POST

Побочные эффекты: Создаёт урок в модуле learning, привязывает его к дереву курса.

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

Параметр Тип Обяз. Описание
title (алиас name) string да Название, 1..255 символов
courseId int да ID курса
parentId int нет Родительский урок в дереве курса. По умолчанию — корневой урок курса
landingId (алиас landingPageId) int нет ID лендинг-страницы для создания лендинг-урока
detailText string нет Содержимое урока (HTML). Игнорируется при landingId
active bool нет По умолчанию true
sort int нет Сортировка, по умолчанию 500

Возвращаемые данные

Полный урок — та же форма, что у ipr.lesson.get.

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR title/courseId не переданы, title длиннее 255 символов, у курса нет корневого урока
PERMISSION_DENIED Нет прав управлять уроками этого курса
INTERNAL_ERROR Не удалось создать урок

Пример запроса (POST)

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.lesson.add.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "title": "Что такое обратная связь 360",
          "courseId": 305,
          "detailText": "<p>Текст урока</p>"
        }'

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

{
          "result": {
            "result": {
              "id": 901,
              "title": "Что такое обратная связь 360",
              "courseId": 305,
              "active": true
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.lesson.get
Следующая
ipr.lesson.update