gamification.level.create

Scope: gamification

Кто может вызывать: Пользователь с правом на изменение настроек модуля (уровень доступа к модулю выше «чтения»; у администратора портала оно есть всегда). Подробнее: Права доступа

Добавить уровень — так же, как ссылка «Добавить уровень» и сохранение строки на вкладке «Уровни» настроек модуля: элемент инфоблока уровней создаётся со значениями по умолчанию и сохраняется с переданными, служебные имена уровней («Уровень 1», «Уровень 2»…) перенумеровываются, таблица уровней пересобирается.

HTTP: POST

Побочные эффекты: новый элемент инфоблока уровней, пересборка таблицы уровней (gamification.level.list).

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

Параметр Тип Обяз. Описание
title string да Название уровня, которое видят сотрудники (псевдонимы: name, LEVEL_NAME)
points int да Количество баллов для уровня, >= 0 (псевдонимы: value, COL_BALL)
code string нет Код уровня (псевдоним: CODE)
sort int нет Сортировка, по умолчанию 500. Порядок уровней в таблице — по сортировке

Иконка уровня по REST не загружается — её задают в настройках модуля.

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

result.result:

Поле Тип Описание
id int ID элемента уровня (нужен для gamification.level.delete)
title string Название уровня
points int Баллы для уровня
value int То же, что points (имя как в gamification.level.list)
code string Код
sort int Сортировка

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

Справочник кодов ошибок.

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет права на изменение настроек модуля
VALIDATION_ERROR Не передан title или points, points < 0, sort не целое
INTERNAL_ERROR Инфоблок уровней не настроен

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.level.create.json" \
          -H "Content-Type: application/json" \
          -d '{"title": "Наставник", "points": 1500, "code": "mentor", "sort": 400}'

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

{
          "result": {
            "result": {
              "id": 734,
              "title": "Наставник",
              "points": 1500,
              "value": 1500,
              "code": "mentor",
              "sort": 400
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
gamification.level.update
Следующая
gamification.level.delete