Коды ошибок REST API модуля ithive.gamification

Методы gamification.* возвращают ошибки в конверте модуля внутри стандартной обёртки Bitrix REST.

Полный перечень кодов совпадает с Ithive\Gamification\Rest\Constants. На страницах методов указаны только актуальные для конкретного метода коды — этот справочник содержит все коды модуля.

Формат ответа при ошибке

{
          "result": {
            "result": null,
            "error": {
              "code": "UNAUTHORIZED",
              "message": "Требуется авторизация.",
              "details": null
            }
          }
        }

details опционален (обычно содержит field, userId, limit, max и другие поля контекста).

Общие коды

Код	HTTP (ориентир)	Когда возникает
`UNAUTHORIZED`	401	Пользователь не авторизован
`ACCESS_DENIED`	403	Метод требует роли admin/manager или права на изменение настроек модуля; параметр «только для администратора» передал не администратор портала; просмотр чужого баланса/истории запрещён
`PERMISSION_DENIED`	403	Нет прав на конкретное действие
`VALIDATION_ERROR`	400	Отсутствует обязательный параметр или он имеет неверный тип/значение
`NOT_FOUND`	404	Сущность с указанным `id` не найдена
`DELETE_FORBIDDEN`	400	Модуль отказывается удалять элемент: «Общий» рейтинг, отказ обработчика удаления (`level.delete`, `rating.delete`, `thanks.category.delete`)
`INVALID_LIMIT`	400	`limit` < 1
`INVALID_OFFSET`	400	`offset` < 0
`INVALID_FILTER`	400	Некорректный `filter` или неизвестное поле
`INVALID_FILTER_OPERATOR`	400	Неизвестный оператор фильтра
`FETCHALL_LIMIT_EXCEEDED`	400	При `fetchAll=true` записей больше защитного лимита (по умолчанию 5000)
`INTERNAL_ERROR`	500	Внутренняя ошибка сервера

Коды домена: пользователи и баланс

Код	HTTP (ориентир)	Когда возникает
`USER_NOT_FOUND`	404	Пользователь с указанным `userId` не найден; для действий от имени сотрудника (`fromUserId`, `userId` в `shop.product.order`, получатель `thanks.send`) — не найден или неактивен
`INSUFFICIENT_BALANCE`	400	Недостаточно баланса (BAL или THX) для операции
`INVALID_CURRENCY`	400	Передана неизвестная валюта (не `BAL` и не `THX`)
`INVALID_OPERATION`	400	Неизвестный тип операции (`operationType`)
`INVALID_ACCRUAL_TYPE`	400	Неизвестный тип начисления (`accrualType`)
`ALREADY_PROCESSED`	400	Транзакция / результат уже зафиксирован (идемпотентная защита)

Коды домена: благодарности

Код	HTTP (ориентир)	Когда возникает
`SELF_THANKS_FORBIDDEN`	400	Попытка отправить благодарность самому себе
`INVALID_CATEGORY`	400	Категория благодарности не найдена или недоступна текущему пользователю
`INSUFFICIENT_THX_BALANCE`	400	Недостаточно THX для отправки благодарности

Коды домена: магазин

Код	HTTP (ориентир)	Когда возникает
`OUT_OF_STOCK`	400	Товар недоступен для заказа (закончился товарный запас или продажи отключены)
`OFFER_REQUIRED`	400	Заказ товара с вариантами без `offerId`
`OFFER_NOT_FOUND`	404	Вариант с указанным `offerId` не принадлежит товару
`OFFER_NOT_AVAILABLE`	400	Вариант недоступен для заказа (неактивен, без цены, закончился) или у товара нет доступных вариантов