gamification.thanks.category.list

Scope: gamification

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

Постраничный список категорий благодарностей, доступных текущему пользователю.

HTTP: GET

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

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

Параметр Тип Обяз. Описание
filter object нет Фильтр в Mongo-стиле
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Вернуть все записи одним ответом (защитный лимит 5000)

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

result.result — массив категорий. result.total — общее количество.

Ключ Описание
ID Идентификатор категории
NAME Название категории
COST Стоимость в THX
ACTIVE Активность (Y/N)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INVALID_FILTER Некорректный фильтр

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

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

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

{
          "result": {
            "result": [
              { "ID": "1", "NAME": "За инициативу", "COST": "3", "ACTIVE": "Y" },
              { "ID": "2", "NAME": "За помощь", "COST": "5", "ACTIVE": "Y" }
            ],
            "total": 2,
            "next": null,
            "error": null
          }
        }
Предыдущая
gamification.thanks.list
Следующая
gamification.thanks.category.get