gamification.balance.get

Scope: gamification

Кто может вызывать: Любой авторизованный пользователь. Для просмотра чужого баланса (userId другого пользователя) — только admin/manager или при наличии права canViewUserBalance. Подробнее: Права доступа

Получить BAL и THX баланс пользователя.

HTTP: GET

Побочные эффекты: нет

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

Параметр Тип Обяз. Описание
userId int нет ID пользователя. По умолчанию — текущий авторизованный пользователь

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

result.result — объект с балансами:

Ключ Тип Описание
BAL int|float Баланс в баллах (BAL)
THX int|float Баланс в благодарностях (THX)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Попытка просмотра чужого баланса без соответствующих прав
USER_NOT_FOUND Пользователь с указанным userId не найден
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/gamification.balance.get.json" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": {
              "BAL": 1250,
              "THX": 30
            },
            "total": null,
            "next": null,
            "error": null
          }
        }
Предыдущая
Баланс
Следующая
gamification.balance.history