ipr.course.delete

Scope: ipr

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

Удаляет курс вместе с его содержимым средствами модуля learning.

HTTP: POST

Побочные эффекты: Необратимо удаляет курс, включая уроки и тесты.

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

Параметр Тип Обяз. Описание
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.course.delete.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{"id": 305}'

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

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

См. также

Предыдущая
ipr.course.update
Следующая
Обзор раздела