ipr.lesson.delete

Scope: ipr

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

Удаляет урок (включая связанную лендинг-страницу, если урок был создан из лендинга).

HTTP: POST

Побочные эффекты: Необратимо удаляет урок из модуля learning.

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

Параметр Тип Обяз. Описание
id int да ID урока

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

Поле Тип Описание
id int ID урока
deleted bool true

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR id не передан или некорректен
NOT_FOUND Урок не найден
PERMISSION_DENIED Нет прав управлять уроками этого курса
INTERNAL_ERROR Не удалось удалить урок

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.lesson.delete.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{"id": 901}'

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

{
          "result": {
            "result": {
              "id": 901,
              "deleted": true
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

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