gamification.event.update

Scope: gamification

Кто может вызывать: Только admin или manager. Подробнее: Права доступа

Обновить секции и/или элементы каталога событий автоматического начисления.

HTTP: POST

Побочные эффекты: изменяет настройки инфоблока каталога событий.

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

Параметр Тип Обяз. Описание
sections object нет Карта {id: поля} для обновления секций (псевдоним: section)
elements object нет Карта {id: поля} для обновления элементов (псевдоним: element)

Хотя бы один из параметров должен быть непустым.

Записываются только поля, которые сохраняет вкладка «События» настроек модуля:

Где Поля
Раздел (sections) ACTIVE (Y/N), DESCRIPTION; ключи настроек модуля user_field, access
Элемент (elements) ACTIVE (Y/N), PROPERTY_VALUES.KRATNOST (булево), PROPERTY_VALUES.YEARS (int), PROPERTY_VALUES.CNT_BONUS (int)

Остальные поля игнорируются. Все id должны принадлежать инфоблоку событий модуля, иначе запрос отклоняется целиком (NOT_FOUND) и ничего не записывается.

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

result.result — объект с результатами обновления секций и элементов.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Вызывающий не является admin/manager
VALIDATION_ERROR sections или elements не является объектом
NOT_FOUND Раздел или элемент не из инфоблока событий модуля (details.sections, details.elements — чужие id)

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.event.update.json" \
          -H "Content-Type: application/json" \
          -d '{
            "elements": {
              "5": { "POINTS": 2, "ACTIVE": "Y" }
            }
          }'

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

{
          "result": {
            "result": {
              "sections": {},
              "elements": { "5": true }
            },
            "total": null,
            "next": null,
            "error": null
          }
        }
Предыдущая
gamification.event.get
Следующая
Уровни