POST api/card/CardBonusActiveBurn
Получение информации о бонусах, которые сгорят или активируются на карте клиента в заданный промежуток времени, с детализацией
Request Information
URI Parameters
None.
Body Parameters
CardBonusActiveBurnRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки пользователя |
string |
None. |
Client |
Идентификатор клиента, по которому нужно вернуть детализацию бонусов |
integer |
None. |
Card |
Номер карты клиента, по которой нужно вернуть детализацию бонусов |
integer |
None. |
BegDate |
Дата начала периода анализа сгораемых/активирующихся бонусов |
date |
None. |
EndDate |
Дата конца периода анализа сгораемых/активирующихся бонусов |
date |
None. |
CountDaysAfter |
Количество дней, в течение которых сгорят и активируются бонусы ("сегодня" = 0) |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "Client": 1, "Card": 1, "BegDate": "2025-02-06T14:58:19.6044027+03:00", "EndDate": "2025-02-06T14:58:19.6044027+03:00", "CountDaysAfter": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<CardBonusActiveBurnRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request"> <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> <BegDate>2025-02-06T14:58:19.6044027+03:00</BegDate> <Card>1</Card> <Client>1</Client> <CountDaysAfter>1</CountDaysAfter> <EndDate>2025-02-06T14:58:19.6044027+03:00</EndDate> <PosCode>sample string 1</PosCode> </CardBonusActiveBurnRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CardBonusActiveBurnResponseName | Description | Type | Additional information |
---|---|---|---|
SumBonusBurn |
Сумма бонусов, которая сгорит за указанный период |
decimal number |
None. |
SumBonusActivate |
Сумма бонусов, которая активируется за указанный период |
decimal number |
None. |
ActBonuses |
Массив бонусов, которые активируются |
Collection of CardBonusActiveBurnActBonus |
None. |
ExpBonuses |
Массив бонусов, которые сгорят |
Collection of CardBonusActiveBurnExpBonus |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "SumBonusBurn": 1.0, "SumBonusActivate": 1.0, "ActBonuses": [ { "Id": 1, "BonusSource": 64, "BonusSourceName": "sample string 1", "Bonus": 1.0, "ActiveDate": "2025-02-06T14:58:19.9481515+03:00", "CountDays": 1 }, { "Id": 1, "BonusSource": 64, "BonusSourceName": "sample string 1", "Bonus": 1.0, "ActiveDate": "2025-02-06T14:58:19.9481515+03:00", "CountDays": 1 } ], "ExpBonuses": [ { "Id": 1, "BonusSource": 64, "BonusSourceName": "sample string 1", "Bonus": 1.0, "ExpiryDate": "2025-02-06T14:58:19.9481515+03:00", "CountDays": 1 }, { "Id": 1, "BonusSource": 64, "BonusSourceName": "sample string 1", "Bonus": 1.0, "ExpiryDate": "2025-02-06T14:58:19.9481515+03:00", "CountDays": 1 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<CardBonusActiveBurnResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response"> <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> <ActBonuses> <CardBonusActiveBurnResponse.CardBonusActiveBurnActBonus> <ActiveDate>2025-02-06T14:58:19.9481515+03:00</ActiveDate> <Bonus>1</Bonus> <BonusSource>64</BonusSource> <BonusSourceName>sample string 1</BonusSourceName> <CountDays>1</CountDays> <Id>1</Id> </CardBonusActiveBurnResponse.CardBonusActiveBurnActBonus> <CardBonusActiveBurnResponse.CardBonusActiveBurnActBonus> <ActiveDate>2025-02-06T14:58:19.9481515+03:00</ActiveDate> <Bonus>1</Bonus> <BonusSource>64</BonusSource> <BonusSourceName>sample string 1</BonusSourceName> <CountDays>1</CountDays> <Id>1</Id> </CardBonusActiveBurnResponse.CardBonusActiveBurnActBonus> </ActBonuses> <ExpBonuses> <CardBonusActiveBurnResponse.CardBonusActiveBurnExpBonus> <Bonus>1</Bonus> <BonusSource>64</BonusSource> <BonusSourceName>sample string 1</BonusSourceName> <CountDays>1</CountDays> <ExpiryDate>2025-02-06T14:58:19.9481515+03:00</ExpiryDate> <Id>1</Id> </CardBonusActiveBurnResponse.CardBonusActiveBurnExpBonus> <CardBonusActiveBurnResponse.CardBonusActiveBurnExpBonus> <Bonus>1</Bonus> <BonusSource>64</BonusSource> <BonusSourceName>sample string 1</BonusSourceName> <CountDays>1</CountDays> <ExpiryDate>2025-02-06T14:58:19.9481515+03:00</ExpiryDate> <Id>1</Id> </CardBonusActiveBurnResponse.CardBonusActiveBurnExpBonus> </ExpBonuses> <SumBonusActivate>1</SumBonusActivate> <SumBonusBurn>1</SumBonusBurn> </CardBonusActiveBurnResponse>