ipr.course.update

Scope: ipr

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

Изменяет курс. Передаются только те поля, которые нужно изменить.

HTTP: POST

Побочные эффекты: Изменяет курс в модуле learning.

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

Параметр Тип Обяз. Описание
id int да ID курса
title (алиас name) string нет Название, 1..255 символов
description string нет Описание
code string нет Символьный код
active bool нет Активность

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

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

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные значения полей
NOT_FOUND Курс не найден
PERMISSION_DENIED Нет прав управлять этим курсом
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.course.update.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{"id": 305, "active": false}'

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

{
          "result": {
            "result": {
              "id": 305,
              "active": false
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.course.add
Следующая
ipr.course.delete