sw24loyaltyprogram.profiles.list
Назначение метода
Метод
Параметры
| Параметр | Обязательный | Описание |
| filter[id] | Отфильтровать записи по идентификатору записи в таблицу модуля. целое число |
|
| filter[sort] | Отфильтровать по приоритету профиля. целое число |
|
| filter[active] | Отфильтровать по активности профиля. Y или N |
|
| filter[name] | Отфильтровать по названию профиля. строка |
|
| filter[type] | Отфильтровать по типу профиля. Тип профиля - это служебный код для маркировки, на текущий момент существует 12 типов1. строка |
|
| filter[date_setting] | Отфильтровать по дате изменения профиля. дата в формате timestamp |
|
| limit | Служебный параметр, указывает сколько записей необходимо вернуть (если не указан - то вернёт 50 записей) целое число |
|
| offset | Служебный параметр, указывает необходимый для пагинации если записей слишком много целое число |
- Birthday - День рождения
- Copyrighter - Вознаграждение правообладателю
- Ordering - Оформление заказа
- Orderpay - Оплата бонусами
- Outersource - Внешний источник
- Profilecompleted - Заполнение профиля
- Registration - Регистрация
- Reviews - Вознаграждение за отзыв
- Subscribe - Вознаграждение за подписку
- Turnover - Достижения пользователя
- TurnoverRef - Достижения рефералодателя
- Writeoff - Вывод средств
В параметрах фильтра можно указывать условия Больше, Меньше и т. п. в соответствии в правилами ORM битрикс. Например, параметр filter[>bonus] выведет все записи у которых размер бонусов более указанной величины
Результат
После успешного выполнения возвращает массив со следующими ключами:
| Ключ | Значение |
| result |
Массив записей полученный в соответствии в запрошенными параметрами фильтра и пагинации. массив |
| next |
Параметр для пагинации, указывающий какое значение нужно указать в параметре offset если все записи не вошли в текущий результирующий массив. целое число |
| total |
общее количество записей удовлетворяющее указанному запросу в соответствии с параметрами фильтра. целое число |
В случае неудачи метод вернёт массив со следующими ключами:
| Ключ | Значение |
| error |
Идентификатор ошибки (если есть) целое число |
| error_description |
Описание возникшей ошибки |
Пример вызова
https://