gamification.currency.list

Scope: gamification

Кто может вызывать: Любой авторизованный пользователь. Подробнее: Права доступа

Получить список валют модуля (BAL и THX) с форматными строками и иконками.

HTTP: GET

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

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

Параметры отсутствуют.

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

result.result — массив валют. result.total — количество.

Ключ Описание
code Код валюты: BAL или THX
name Название валюты
format Строка форматирования (например, {value} б.)
icon URL иконки (если задана)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован

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

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

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

{
          "result": {
            "result": [
              { "code": "BAL", "name": "Баллы", "format": "{value} б.", "icon": null },
              { "code": "THX", "name": "Благодарности", "format": "{value} thx", "icon": null }
            ],
            "total": 2,
            "next": null,
            "error": null
          }
        }
        
Предыдущая