gamification.rating.participant.list
Scope:
gamificationКто может вызывать: Любой авторизованный пользователь. Подробнее: Права доступа
Постраничный список участников рейтинга из таблицы HighLoad-блока.
HTTP: GET
Побочные эффекты: нет
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
filter |
object |
нет | Фильтр в Mongo-стиле по полям HL-таблицы участников (см. ниже) |
limit |
int |
нет | Размер страницы, по умолчанию 50, максимум 500 |
offset |
int |
нет | Смещение, по умолчанию 0 |
fetchAll |
bool |
нет | Вернуть все записи одним ответом (защитный лимит 5000) |
Допустимые поля filter
| Поле | Описание |
|---|---|
ID |
ID записи участника |
UF_ITHIVE_HONOUR_USER |
ID пользователя |
UF_ITHIVE_HONOUR_USER_PLACE |
Место в рейтинге |
UF_ITHIVE_HONOUR_USER_PLACE_BACK |
Предыдущее место |
UF_ITHIVE_HONOUR_USER_MONTH |
Месяц |
UF_ITHIVE_HONOUR_USER_YEAR |
Год |
UF_ITHIVE_HONOUR_RATING_NAME |
Код/имя рейтинга (LOGIC_FOLDER) |
UF_ITHIVE_HONOUR_DETAILING |
Детализация |
Неизвестное поле — ошибка INVALID_FILTER.
Возвращаемые данные
result.result — массив записей участников. result.total — общее количество.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INVALID_FILTER |
Некорректный фильтр или неизвестное поле |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/gamification.rating.participant.list.json" \
-H "Accept: application/json" \
--data-urlencode 'filter[UF_ITHIVE_HONOUR_RATING_NAME]=activity'
Предыдущая