POST api/birthdayrule/ActionPagingInfo
Получение информации о действиях по правилу, настроенных по механике "День рождения", с пагинацией и входными фильтрами
Request Information
URI Parameters
None.
Body Parameters
BirthdayRuleRequestActionPagingInfoName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки пользователя |
string |
None. |
BirthdayRule |
Идентификатор правила |
integer |
None. |
BirthdayRuleAction |
Фильтр: идентификатор действия по правилу, по которому требуется получить информацию |
integer |
None. |
OnlyActive |
Фильтр: вернуть только активные правила |
boolean |
None. |
BonusActionBegTime |
Фильтр: желаемое время начисленяи бонусов |
time interval |
None. |
MessageActionBegTime |
Фильтр: желаемое время отправки коммуникаций |
time interval |
None. |
Bonus |
Фильтр: кол-во начисляемых бонусов |
decimal number |
None. |
BonusExpDays |
Фильтр: срок жизни бонусов с момента начисления |
integer |
None. |
MessageTemplate |
Фильтр: идентификатор шаблона коммуникации |
integer |
None. |
CommunicationType |
Фильтр: тип коммуникации |
byte |
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
{ "PosCode": "sample string 1", "BirthdayRule": 1, "BirthdayRuleAction": 1, "OnlyActive": true, "BonusActionBegTime": "00:00:00.1234567", "MessageActionBegTime": "00:00:00.1234567", "Bonus": 1.0, "BonusExpDays": 1, "MessageTemplate": 1, "CommunicationType": 64, "Start": 1, "Length": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<ActionPagingInfoRequest 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 2</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <BirthdayRule>1</BirthdayRule> <BirthdayRuleAction>1</BirthdayRuleAction> <Bonus>1</Bonus> <BonusActionBegTime>PT0.1234567S</BonusActionBegTime> <BonusExpDays>1</BonusExpDays> <CommunicationType>64</CommunicationType> <Length>1</Length> <MessageActionBegTime>PT0.1234567S</MessageActionBegTime> <MessageTemplate>1</MessageTemplate> <OnlyActive>true</OnlyActive> <PosCode>sample string 1</PosCode> <Start>1</Start> </ActionPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
BirthdayRuleResponseActionPagingInfoName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Количество записей, которые попали в выборку |
integer |
None. |
TotalRowsSelect |
Количество записей, которые вернулись в массиве ответа на запрос |
integer |
None. |
Data |
Список |
Collection of ActionPagingInfoDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TotalRows": 1, "TotalRowsSelect": 1, "Data": [ { "BirthdayRule": 1, "BirthdayRuleName": "sample string 1", "BirthdayRuleAction": 1, "Bonus": 1.0, "BonusExpDays": 1, "IsActive": true, "BonusActionBegTime": "00:00:00.1234567", "MessageActionBegTime": "00:00:00.1234567", "MessageTemplate": 1, "CommunicationType": 64, "TemplateText": "sample string 2", "ActionType": 64, "CommunicationTypeName": "sample string 3" }, { "BirthdayRule": 1, "BirthdayRuleName": "sample string 1", "BirthdayRuleAction": 1, "Bonus": 1.0, "BonusExpDays": 1, "IsActive": true, "BonusActionBegTime": "00:00:00.1234567", "MessageActionBegTime": "00:00:00.1234567", "MessageTemplate": 1, "CommunicationType": 64, "TemplateText": "sample string 2", "ActionType": 64, "CommunicationTypeName": "sample string 3" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<ActionPagingInfoResponse 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> <ActionPagingInfoResponse.ActionPagingInfoDataRow> <ActionType>64</ActionType> <BirthdayRule>1</BirthdayRule> <BirthdayRuleAction>1</BirthdayRuleAction> <BirthdayRuleName>sample string 1</BirthdayRuleName> <Bonus>1</Bonus> <BonusActionBegTime>PT0.1234567S</BonusActionBegTime> <BonusExpDays>1</BonusExpDays> <CommunicationType>64</CommunicationType> <CommunicationTypeName>sample string 3</CommunicationTypeName> <IsActive>true</IsActive> <MessageActionBegTime>PT0.1234567S</MessageActionBegTime> <MessageTemplate>1</MessageTemplate> <TemplateText>sample string 2</TemplateText> </ActionPagingInfoResponse.ActionPagingInfoDataRow> <ActionPagingInfoResponse.ActionPagingInfoDataRow> <ActionType>64</ActionType> <BirthdayRule>1</BirthdayRule> <BirthdayRuleAction>1</BirthdayRuleAction> <BirthdayRuleName>sample string 1</BirthdayRuleName> <Bonus>1</Bonus> <BonusActionBegTime>PT0.1234567S</BonusActionBegTime> <BonusExpDays>1</BonusExpDays> <CommunicationType>64</CommunicationType> <CommunicationTypeName>sample string 3</CommunicationTypeName> <IsActive>true</IsActive> <MessageActionBegTime>PT0.1234567S</MessageActionBegTime> <MessageTemplate>1</MessageTemplate> <TemplateText>sample string 2</TemplateText> </ActionPagingInfoResponse.ActionPagingInfoDataRow> </Data> <TotalRows>1</TotalRows> <TotalRowsSelect>1</TotalRowsSelect> </ActionPagingInfoResponse>