gamification.level.current

Scope: gamification

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

Получить текущий уровень и прогресс до следующего уровня для пользователя.

HTTP: GET

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

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

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

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

result.result — объект с данными о текущем уровне и прогрессе:

Ключ Описание
current Объект текущего уровня (ID, NAME, THRESHOLD, ICON)
next Объект следующего уровня или null если максимальный
balance Текущий баланс BAL пользователя
progress Прогресс от 0 до 100 (%) до следующего порога

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

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

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

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

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

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

{
          "result": {
            "result": {
              "current": { "ID": "1", "NAME": "Новичок", "THRESHOLD": "0" },
              "next": { "ID": "2", "NAME": "Опытный", "THRESHOLD": "500" },
              "balance": 250,
              "progress": 50
            },
            "total": null,
            "next": null,
            "error": null
          }
        }
Предыдущая
gamification.level.list
Следующая
gamification.level.update