gamification.event.list

Scope: gamification

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

Постраничный список секций каталога событий автоматического начисления с вложенными элементами.

HTTP: GET

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

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

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

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

result.result — массив секций, каждая содержит вложенный массив элементов событий.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INVALID_FILTER Некорректный фильтр
FETCHALL_LIMIT_EXCEEDED Превышен защитный лимит при fetchAll=true

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

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

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

{
          "result": {
            "result": [
              {
                "ID": "1",
                "NAME": "Активность в системе",
                "items": [
                  { "ID": "5", "NAME": "Вход в систему", "POINTS": "1" }
                ]
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }
Предыдущая
События начисления
Следующая
gamification.event.get