ipr.course.add

Scope: ipr

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

Создаёт курс обучения.

HTTP: POST

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

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

Параметр Тип Обяз. Описание
title (алиас name) string да Название, 1..255 символов
siteId string|string[] нет Сайт(ы) курса. По умолчанию — текущий сайт
description string нет Описание курса
code string нет Символьный код
active bool нет По умолчанию true

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

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

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

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

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

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.course.add.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{"title": "Обратная связь 360", "code": "feedback-360"}'

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

{
          "result": {
            "result": {
              "id": 305,
              "title": "Обратная связь 360",
              "code": "feedback-360",
              "active": true
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

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