POST api/birthdayrule/PagingInfo

Получение информации о правилах, настроенных по механике "День рождения", с пагинацией и входными фильтрами

Request Information

URI Parameters

None.

Body Parameters

BirthdayRuleRequestPagingInfo
NameDescriptionTypeAdditional information
PosCode

Код торговой точки пользователя, который делает запрос

 string

None.
OnlyActive

Фильтр: вернуть только активные правила

 boolean

None.
Name

Фильтр: наименование правила

 string

None.
BirthdayRuleId

Фильтр: идентификатор правила

 integer

None.
MinPurchases

Фильтр: минимальное кол-во покупок у карты клиента

 integer

None.
MinPurchasesSum

Фильтр: минимальная сумма покупок у карты клиента

 decimal number

None.
MinDaysFromRegDate

Фильтр: минимальное кол-во дней что должно пройти от даты регистрации клиента

 integer

None.
Partner

Идентификатор партнера, от которого идёт начисление бонусов и отправка коммуникаций

 integer

None.
Pos

Идентификатор торговой точки, от которой идёт начисление бонусов и отправка коммуникаций

 integer

None.
Type

Фильтр: тип правила, если задан, то требуется группировать правила при проверке

 byte

None.
TypeGroupId

Фильтр: идентификатор группы, если тип больше нуля, то по нему идёт группировка правил для проверки срабатывания

 integer

None.
Children

Фильтр: признак, что правило работает на детей

 boolean

None.
BirthdayRuleType

Фильтр: не используется

 byte

None.
BirthdayRuleGroup

Фильтр: не используется

 integer

None.
DaysBefore

Кол-во дней до ДР для выборки клиентов

 byte

None.
DaysLater

Кол-во дней после ДР для выборки клиентов

 byte

None.
Level

Фильтр: уровень карты для выборки клиентов

 integer

None.
MinPurchaseSum

Фильтр: минимальное сумма покупок для выборки клиентов

 decimal number

None.
RegPartner

Фильтр: идентификатор партера, в торговых точка которого произошла регистрация клиента

 integer

None.
RegPartnerList

Фильтр: идентификатор списка партнеров, в торговых точка которых произошла регистрация клиента

 integer

None.
RegPos

Фильтр: идентификатор торговой точки регистрации клиента

 integer

None.
RegPosList

Фильтр: идентификатор списка торговых точек, в которых произошла регистрация клиента

 integer

None.
RegCity

Фильтр: идентификатор города, в торговых точка которого произошла регистрация клиента

 integer

None.
PurchasePartner

Фильтр: парнер в торговых точках которого были покупки

 integer

None.
PurchasePartnerList

Фильтр: парнер в торговых точках которого были покупки

 integer

None.
PurchasePos

Фильтр: торговая точка в которой были покупки

 integer

None.
PurchasePosList

Фильтр: торговая точка в которой были покупки

 integer

None.
PurchaseCity

Фильтр: торговая точка в которой были покупки

 integer

None.
MarketList

Фильтр: идентификатор маркетингового списка в который должна входить карта клиента

 integer

None.
NoMarketList

Фильтр: идентификатор маркетингового списка в который должна входить карта клиента

 integer

None.
ClientList

Фильтр: идентификатор списка клиентов в который должна входить карта клиента

 integer

None.
NoClientList

Фильтр: идентификатор списка клиентов в который должна входить карта клиента

 integer

None.
CardType

Фильтр: идентификатор типа карты, что фильтрует выборку

 integer

None.
NoCardType

Фильтр: идентификатор типа карты, что требуется исключить из выборки карты определенного типа указанные в таблице cardtype

 integer

None.
CardTypeList

Фильтр: идентификатор списка типов карт в который должен входить тип карты клиента

 integer

None.
NoCardTypeList

Фильтр: идентификатор списка типов карт в который не должен входить тип карты клиента

 integer

None.
StrictDateBefore

Фильтр: строгое кол-во дней, если указано, то клиент попадает в механику ровно в указанное кол-во дней до ДР, иначе в промежутке "от и до"

 boolean

None.
LastPurchaseMonthAgo

Фильтр: кол-во месяцев от сегодня в которые клиент совершил покупку

 integer

None.
PurchaseMaxMonthAgo

Фильтр: кол-во месяцев от сегодня в которые клиент совершил покупку с условиями

 integer

None.
PurchaseMinPurchases

Фильтр: минимальное кол-во покупок за период

 integer

None.
PurchaseMaxPurchases

Фильтр: максимальное кол-во покупок за период

 integer

None.
PurchaseMinPurchaseSum

Фильтр: минимальная сумма покупок за период

 decimal number

None.
PurchaseMaxPurchaseSum

Фильтр: максимальная сумма покупок за период

 decimal number

None.
Start

Пагинация: последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.)

 integer

None.
Length

Пагинация: количество записей, которые нужно вернуть

 integer

None.
Operator

Идентификатор оператора программы лояльности

 integer

None.
Token

Токен пользователя, который инициирует данный запрос

 integer

None.
SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PosCode": "sample string 1",
  "OnlyActive": true,
  "Name": "sample string 2",
  "BirthdayRuleId": 1,
  "MinPurchases": 1,
  "MinPurchasesSum": 1.0,
  "MinDaysFromRegDate": 1,
  "Partner": 1,
  "Pos": 1,
  "Type": 64,
  "TypeGroupId": 1,
  "Children": true,
  "BirthdayRuleType": 64,
  "BirthdayRuleGroup": 1,
  "DaysBefore": 64,
  "DaysLater": 64,
  "Level": 1,
  "MinPurchaseSum": 1.0,
  "RegPartner": 1,
  "RegPartnerList": 1,
  "RegPos": 1,
  "RegPosList": 1,
  "RegCity": 1,
  "PurchasePartner": 1,
  "PurchasePartnerList": 1,
  "PurchasePos": 1,
  "PurchasePosList": 1,
  "PurchaseCity": 1,
  "MarketList": 1,
  "NoMarketList": 1,
  "ClientList": 1,
  "NoClientList": 1,
  "CardType": 1,
  "NoCardType": 1,
  "CardTypeList": 1,
  "NoCardTypeList": 1,
  "StrictDateBefore": true,
  "LastPurchaseMonthAgo": 1,
  "PurchaseMaxMonthAgo": 1,
  "PurchaseMinPurchases": 1,
  "PurchaseMaxPurchases": 1,
  "PurchaseMinPurchaseSum": 1.0,
  "PurchaseMaxPurchaseSum": 1.0,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<PagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.BirthdayRuleRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BirthdayRuleGroup>1</BirthdayRuleGroup>
  <BirthdayRuleId>1</BirthdayRuleId>
  <BirthdayRuleType>64</BirthdayRuleType>
  <CardType>1</CardType>
  <CardTypeList>1</CardTypeList>
  <Children>true</Children>
  <ClientList>1</ClientList>
  <DaysBefore>64</DaysBefore>
  <DaysLater>64</DaysLater>
  <LastPurchaseMonthAgo>1</LastPurchaseMonthAgo>
  <Length>1</Length>
  <Level>1</Level>
  <MarketList>1</MarketList>
  <MinDaysFromRegDate>1</MinDaysFromRegDate>
  <MinPurchaseSum>1</MinPurchaseSum>
  <MinPurchases>1</MinPurchases>
  <MinPurchasesSum>1</MinPurchasesSum>
  <Name>sample string 2</Name>
  <NoCardType>1</NoCardType>
  <NoCardTypeList>1</NoCardTypeList>
  <NoClientList>1</NoClientList>
  <NoMarketList>1</NoMarketList>
  <OnlyActive>true</OnlyActive>
  <Partner>1</Partner>
  <Pos>1</Pos>
  <PosCode>sample string 1</PosCode>
  <PurchaseCity>1</PurchaseCity>
  <PurchaseMaxMonthAgo>1</PurchaseMaxMonthAgo>
  <PurchaseMaxPurchaseSum>1</PurchaseMaxPurchaseSum>
  <PurchaseMaxPurchases>1</PurchaseMaxPurchases>
  <PurchaseMinPurchaseSum>1</PurchaseMinPurchaseSum>
  <PurchaseMinPurchases>1</PurchaseMinPurchases>
  <PurchasePartner>1</PurchasePartner>
  <PurchasePartnerList>1</PurchasePartnerList>
  <PurchasePos>1</PurchasePos>
  <PurchasePosList>1</PurchasePosList>
  <RegCity>1</RegCity>
  <RegPartner>1</RegPartner>
  <RegPartnerList>1</RegPartnerList>
  <RegPos>1</RegPos>
  <RegPosList>1</RegPosList>
  <Start>1</Start>
  <StrictDateBefore>true</StrictDateBefore>
  <Type>64</Type>
  <TypeGroupId>1</TypeGroupId>
</PagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BirthdayRuleResponsePagingInfo
NameDescriptionTypeAdditional information
TotalRows

Количество записей, которые попали в выборку

 integer

None.
TotalRowsSelect

Количество записей, которые вернулись в массиве ответа на запрос

 integer

None.
Data

Список

 Collection of PagingInfoDataRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

Сообщение об ошибке

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "BirthdayRuleId": 1,
      "Name": "sample string 1",
      "Partner": 1,
      "Pos": 1,
      "NoActive": true,
      "Type": 64,
      "TypeGroupid": 1,
      "Children": true,
      "BirthdayRuleType": 64,
      "BirthdayRuleGroup": 1,
      "DaysBefore": 64,
      "DaysLater": 64,
      "Level": 1,
      "MinPurchases": 1,
      "MinPurchaseSum": 1.0,
      "RegPartner": 1,
      "RegPartnerList": 1,
      "RegPos": 1,
      "RegPosList": 1,
      "RegCity": 1,
      "PurchasePartner": 1,
      "PurchasePartnerList": 1,
      "PurchasePos": 1,
      "PurchasePosList": 1,
      "PurchaseCity": 1,
      "MarketList": 1,
      "NoMarketList": 1,
      "ClientList": 1,
      "NoClientList": 1,
      "CardType": 1,
      "NoCardType": 1,
      "CardTypeList": 1,
      "NoCardTypeList": 1,
      "StrictDateBefore": true,
      "LastPurchaseMonthAgo": 1,
      "PurchaseMaxMonthAgo": 1,
      "PurchaseMinPurchases": 1,
      "PurchaseMaxPurchases": 1,
      "PurchaseMinPurchaseSum": 1.0,
      "PurchaseMaxPurchaseSum": 1.0,
      "CardTypeName": "sample string 2",
      "CardTypeListName": "sample string 3",
      "MarketListName": "sample string 4",
      "ClientListName": "sample string 5",
      "PurchasePosName": "sample string 6",
      "PurchasePartnerName": "sample string 7",
      "RegPosName": "sample string 8",
      "RegPosListName": "sample string 9",
      "RePartnerName": "sample string 10",
      "RegPartnerListName": "sample string 11",
      "RegCityName": "sample string 12",
      "RegCityListName": "sample string 13"
    },
    {
      "BirthdayRuleId": 1,
      "Name": "sample string 1",
      "Partner": 1,
      "Pos": 1,
      "NoActive": true,
      "Type": 64,
      "TypeGroupid": 1,
      "Children": true,
      "BirthdayRuleType": 64,
      "BirthdayRuleGroup": 1,
      "DaysBefore": 64,
      "DaysLater": 64,
      "Level": 1,
      "MinPurchases": 1,
      "MinPurchaseSum": 1.0,
      "RegPartner": 1,
      "RegPartnerList": 1,
      "RegPos": 1,
      "RegPosList": 1,
      "RegCity": 1,
      "PurchasePartner": 1,
      "PurchasePartnerList": 1,
      "PurchasePos": 1,
      "PurchasePosList": 1,
      "PurchaseCity": 1,
      "MarketList": 1,
      "NoMarketList": 1,
      "ClientList": 1,
      "NoClientList": 1,
      "CardType": 1,
      "NoCardType": 1,
      "CardTypeList": 1,
      "NoCardTypeList": 1,
      "StrictDateBefore": true,
      "LastPurchaseMonthAgo": 1,
      "PurchaseMaxMonthAgo": 1,
      "PurchaseMinPurchases": 1,
      "PurchaseMaxPurchases": 1,
      "PurchaseMinPurchaseSum": 1.0,
      "PurchaseMaxPurchaseSum": 1.0,
      "CardTypeName": "sample string 2",
      "CardTypeListName": "sample string 3",
      "MarketListName": "sample string 4",
      "ClientListName": "sample string 5",
      "PurchasePosName": "sample string 6",
      "PurchasePartnerName": "sample string 7",
      "RegPosName": "sample string 8",
      "RegPosListName": "sample string 9",
      "RePartnerName": "sample string 10",
      "RegPartnerListName": "sample string 11",
      "RegCityName": "sample string 12",
      "RegCityListName": "sample string 13"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<PagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.BirthdayRuleResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Data>
    <PagingInfoResponse.PagingInfoDataRow>
      <BirthdayRuleGroup>1</BirthdayRuleGroup>
      <BirthdayRuleId>1</BirthdayRuleId>
      <BirthdayRuleType>64</BirthdayRuleType>
      <CardType>1</CardType>
      <CardTypeList>1</CardTypeList>
      <CardTypeListName>sample string 3</CardTypeListName>
      <CardTypeName>sample string 2</CardTypeName>
      <Children>true</Children>
      <ClientList>1</ClientList>
      <ClientListName>sample string 5</ClientListName>
      <DaysBefore>64</DaysBefore>
      <DaysLater>64</DaysLater>
      <LastPurchaseMonthAgo>1</LastPurchaseMonthAgo>
      <Level>1</Level>
      <MarketList>1</MarketList>
      <MarketListName>sample string 4</MarketListName>
      <MinPurchaseSum>1</MinPurchaseSum>
      <MinPurchases>1</MinPurchases>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <NoCardType>1</NoCardType>
      <NoCardTypeList>1</NoCardTypeList>
      <NoClientList>1</NoClientList>
      <NoMarketList>1</NoMarketList>
      <Partner>1</Partner>
      <Pos>1</Pos>
      <PurchaseCity>1</PurchaseCity>
      <PurchaseMaxMonthAgo>1</PurchaseMaxMonthAgo>
      <PurchaseMaxPurchaseSum>1</PurchaseMaxPurchaseSum>
      <PurchaseMaxPurchases>1</PurchaseMaxPurchases>
      <PurchaseMinPurchaseSum>1</PurchaseMinPurchaseSum>
      <PurchaseMinPurchases>1</PurchaseMinPurchases>
      <PurchasePartner>1</PurchasePartner>
      <PurchasePartnerList>1</PurchasePartnerList>
      <PurchasePartnerName>sample string 7</PurchasePartnerName>
      <PurchasePos>1</PurchasePos>
      <PurchasePosList>1</PurchasePosList>
      <PurchasePosName>sample string 6</PurchasePosName>
      <RePartnerName>sample string 10</RePartnerName>
      <RegCity>1</RegCity>
      <RegCityListName>sample string 13</RegCityListName>
      <RegCityName>sample string 12</RegCityName>
      <RegPartner>1</RegPartner>
      <RegPartnerList>1</RegPartnerList>
      <RegPartnerListName>sample string 11</RegPartnerListName>
      <RegPos>1</RegPos>
      <RegPosList>1</RegPosList>
      <RegPosListName>sample string 9</RegPosListName>
      <RegPosName>sample string 8</RegPosName>
      <StrictDateBefore>true</StrictDateBefore>
      <Type>64</Type>
      <TypeGroupid>1</TypeGroupid>
    </PagingInfoResponse.PagingInfoDataRow>
    <PagingInfoResponse.PagingInfoDataRow>
      <BirthdayRuleGroup>1</BirthdayRuleGroup>
      <BirthdayRuleId>1</BirthdayRuleId>
      <BirthdayRuleType>64</BirthdayRuleType>
      <CardType>1</CardType>
      <CardTypeList>1</CardTypeList>
      <CardTypeListName>sample string 3</CardTypeListName>
      <CardTypeName>sample string 2</CardTypeName>
      <Children>true</Children>
      <ClientList>1</ClientList>
      <ClientListName>sample string 5</ClientListName>
      <DaysBefore>64</DaysBefore>
      <DaysLater>64</DaysLater>
      <LastPurchaseMonthAgo>1</LastPurchaseMonthAgo>
      <Level>1</Level>
      <MarketList>1</MarketList>
      <MarketListName>sample string 4</MarketListName>
      <MinPurchaseSum>1</MinPurchaseSum>
      <MinPurchases>1</MinPurchases>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <NoCardType>1</NoCardType>
      <NoCardTypeList>1</NoCardTypeList>
      <NoClientList>1</NoClientList>
      <NoMarketList>1</NoMarketList>
      <Partner>1</Partner>
      <Pos>1</Pos>
      <PurchaseCity>1</PurchaseCity>
      <PurchaseMaxMonthAgo>1</PurchaseMaxMonthAgo>
      <PurchaseMaxPurchaseSum>1</PurchaseMaxPurchaseSum>
      <PurchaseMaxPurchases>1</PurchaseMaxPurchases>
      <PurchaseMinPurchaseSum>1</PurchaseMinPurchaseSum>
      <PurchaseMinPurchases>1</PurchaseMinPurchases>
      <PurchasePartner>1</PurchasePartner>
      <PurchasePartnerList>1</PurchasePartnerList>
      <PurchasePartnerName>sample string 7</PurchasePartnerName>
      <PurchasePos>1</PurchasePos>
      <PurchasePosList>1</PurchasePosList>
      <PurchasePosName>sample string 6</PurchasePosName>
      <RePartnerName>sample string 10</RePartnerName>
      <RegCity>1</RegCity>
      <RegCityListName>sample string 13</RegCityListName>
      <RegCityName>sample string 12</RegCityName>
      <RegPartner>1</RegPartner>
      <RegPartnerList>1</RegPartnerList>
      <RegPartnerListName>sample string 11</RegPartnerListName>
      <RegPos>1</RegPos>
      <RegPosList>1</RegPosList>
      <RegPosListName>sample string 9</RegPosListName>
      <RegPosName>sample string 8</RegPosName>
      <StrictDateBefore>true</StrictDateBefore>
      <Type>64</Type>
      <TypeGroupid>1</TypeGroupid>
    </PagingInfoResponse.PagingInfoDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</PagingInfoResponse>