Вход / Регистрация 0
Реферальная программа лояльности

sw24loyaltyprogram.ranks.user.list

Время чтения: ~2 мин.
Обновлено: 31.10.2022

Назначение метода

Метод sw24loyaltyprogram.ranks.user.list показывает список рангов пользователя.

Параметры

Параметр Описание Применение
id

Идентификатор записи в таблице

Целое число

Сортировка: order[id]=desc
Фильтрация: filter[id]=10
user_id

Ид пользователя

Целое число

Сортировка: order[user_id]=desc
Фильтрация: filter[user_idt]=10
rank_id

Ид ранга

Целое число

Сортировка: order[rank_id]=desc
Фильтрация: filter[rank_id]=10
active

Активность ранга

Символ

Сортировка: order[active]=asc
Фильтрация: filter[active]=Y
params

В параметрах ключ 'lock_user' с указанием на запрет смены ранга

Строка

Сортировка: order[params]=asc
Фильтрация:
date_setting

Дата изменения

дата в формате timestamp

Сортировка: order[date_setting]=asc
Фильтрация:
limit

Служебный параметр, указывает сколько записей необходимо вернуть (если не указан - то вернёт 50 записей)

Целое число

limit=10
offset

Служебный параметр, указывает необходимый для пагинации если записей слишком много

Целое число

offset=10

Результат

После успешного выполнения возвращает массив со следующими ключами:

Ключ Значение
result

Массив записей полученный в соответствии в запрошенными параметрами фильтра и пагинации

Массив

next

Параметр для пагинации, указывающий какое значение нужно указать в параметре offset если все записи не вошли в текущий результирующий массив

целое число

total

Общее количество записей удовлетворяющее указанному запросу в соответствии с параметрами фильтра

Целое число

В случае неудачи метод вернёт массив со следующими ключами:

Ключ Значение
error

Идентификатор ошибки (если есть)

Целое число

error_description

Описание возникшей ошибки

Пример вызова

https://{адрес_сайта}/rest/{id_пользователя}/{код_доступа}/sw24loyaltyprogram.ranks.user.list?order[id]=desc&filter[user_id]=5&limit=5