POST api/level/BurnConfirmPeriod
Получение информации о клиентах и уровнях карты клиента, у которых в заданный промежуток времени будет инициирована процедура подтверждения уровня карты или уже была пройдена
Request Information
URI Parameters
None.
Body Parameters
BurnConfirmPeriodRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки пользователя |
string |
None. |
BegDate |
Дата начала периода анализа состояния уровней карт |
date |
None. |
EndDate |
Дата начала периода анализа подтверждаемых уровней |
date |
None. |
CountDays |
Количество дней от сегодня ("завтра" = 1), через которое будут подтверждаться уровни или подтверждались уровни (не в течение которых, а через которое) |
integer |
None. |
MarketListCreate |
Признак, создавать или нет из результатов выборки маркетинговый список карт |
boolean |
None. |
After |
Фильтр: рассматриваемый период "после процедуры подтверждения" (верни тех, у кого сгорело...) |
boolean |
None. |
Before |
Фильтр: рассматриваемый период "до процедуры подтверждения" (верни тех, у кого сгорит...) |
boolean |
None. |
OnlyBurn |
Фильтр: возвращаем только те уровни, которые сгорели (не подтвердились); если не указан, возвращаются все клиенты, которые проходили проверку |
boolean |
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", "BegDate": "2025-02-06T16:52:05.5723843+03:00", "EndDate": "2025-02-06T16:52:05.5723843+03:00", "CountDays": 1, "MarketListCreate": true, "After": true, "Before": true, "OnlyBurn": true, "Start": 1, "Length": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<BurnConfirmPeriodRequest 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> <After>true</After> <Before>true</Before> <BegDate>2025-02-06T16:52:05.5723843+03:00</BegDate> <CountDays>1</CountDays> <EndDate>2025-02-06T16:52:05.5723843+03:00</EndDate> <Length>1</Length> <MarketListCreate>true</MarketListCreate> <OnlyBurn>true</OnlyBurn> <PosCode>sample string 1</PosCode> <Start>1</Start> </BurnConfirmPeriodRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
BurnConfirmPeriodResponseName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Общее количество запcией, которое попало в выборку |
integer |
None. |
TotalRowsSelect |
Общее количество записей, которое вернулось в ответ на запрос |
integer |
None. |
MarketList |
Идентификатор созданного маркетингового списка |
integer |
None. |
BurnBefore |
Массив уровней, которые сгорят |
Collection of BurnConfirmPeriodBurnBefore |
None. |
BurnAfter |
Массив уровней, которые прошли проверку |
Collection of BurnConfirmPeriodBurnAfter |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TotalRows": 1, "TotalRowsSelect": 1, "MarketList": 1, "BurnBefore": [ { "Id": 1, "Client": 1, "Phone": 1, "LevelId": 1, "LevelName": "sample string 1", "LevelStep": 64, "LevelLastDateConfirm": "2025-02-06T16:52:05.9005069+03:00", "LevelDaysAction": 1, "LevelDateAction": "2025-02-06T16:52:05.9005069+03:00", "SumExceeds": 1.0, "SumConfirm": 1.0, "SumNextLevel": 1.0, "SumLastPeriod": 1.0, "ConfirmPurchases": 1.0 }, { "Id": 1, "Client": 1, "Phone": 1, "LevelId": 1, "LevelName": "sample string 1", "LevelStep": 64, "LevelLastDateConfirm": "2025-02-06T16:52:05.9005069+03:00", "LevelDaysAction": 1, "LevelDateAction": "2025-02-06T16:52:05.9005069+03:00", "SumExceeds": 1.0, "SumConfirm": 1.0, "SumNextLevel": 1.0, "SumLastPeriod": 1.0, "ConfirmPurchases": 1.0 } ], "BurnAfter": [ { "Id": 1, "Burn": true, "Client": 1, "Phone": 1, "OldLevelId": 1, "OldLevelName": "sample string 1", "LevelId": 1, "LevelName": "sample string 2", "LevelDateAction": "2025-02-06T16:52:05.9005069+03:00" }, { "Id": 1, "Burn": true, "Client": 1, "Phone": 1, "OldLevelId": 1, "OldLevelName": "sample string 1", "LevelId": 1, "LevelName": "sample string 2", "LevelDateAction": "2025-02-06T16:52:05.9005069+03:00" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<BurnConfirmPeriodResponse 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> <BurnAfter> <BurnConfirmPeriodResponse.BurnConfirmPeriodBurnAfter> <Burn>true</Burn> <Client>1</Client> <Id>1</Id> <LevelDateAction>2025-02-06T16:52:05.9005069+03:00</LevelDateAction> <LevelId>1</LevelId> <LevelName>sample string 2</LevelName> <OldLevelId>1</OldLevelId> <OldLevelName>sample string 1</OldLevelName> <Phone>1</Phone> </BurnConfirmPeriodResponse.BurnConfirmPeriodBurnAfter> <BurnConfirmPeriodResponse.BurnConfirmPeriodBurnAfter> <Burn>true</Burn> <Client>1</Client> <Id>1</Id> <LevelDateAction>2025-02-06T16:52:05.9005069+03:00</LevelDateAction> <LevelId>1</LevelId> <LevelName>sample string 2</LevelName> <OldLevelId>1</OldLevelId> <OldLevelName>sample string 1</OldLevelName> <Phone>1</Phone> </BurnConfirmPeriodResponse.BurnConfirmPeriodBurnAfter> </BurnAfter> <BurnBefore> <BurnConfirmPeriodResponse.BurnConfirmPeriodBurnBefore> <Client>1</Client> <ConfirmPurchases>1</ConfirmPurchases> <Id>1</Id> <LevelDateAction>2025-02-06T16:52:05.9005069+03:00</LevelDateAction> <LevelDaysAction>1</LevelDaysAction> <LevelId>1</LevelId> <LevelLastDateConfirm>2025-02-06T16:52:05.9005069+03:00</LevelLastDateConfirm> <LevelName>sample string 1</LevelName> <LevelStep>64</LevelStep> <Phone>1</Phone> <SumConfirm>1</SumConfirm> <SumExceeds>1</SumExceeds> <SumLastPeriod>1</SumLastPeriod> <SumNextLevel>1</SumNextLevel> </BurnConfirmPeriodResponse.BurnConfirmPeriodBurnBefore> <BurnConfirmPeriodResponse.BurnConfirmPeriodBurnBefore> <Client>1</Client> <ConfirmPurchases>1</ConfirmPurchases> <Id>1</Id> <LevelDateAction>2025-02-06T16:52:05.9005069+03:00</LevelDateAction> <LevelDaysAction>1</LevelDaysAction> <LevelId>1</LevelId> <LevelLastDateConfirm>2025-02-06T16:52:05.9005069+03:00</LevelLastDateConfirm> <LevelName>sample string 1</LevelName> <LevelStep>64</LevelStep> <Phone>1</Phone> <SumConfirm>1</SumConfirm> <SumExceeds>1</SumExceeds> <SumLastPeriod>1</SumLastPeriod> <SumNextLevel>1</SumNextLevel> </BurnConfirmPeriodResponse.BurnConfirmPeriodBurnBefore> </BurnBefore> <MarketList>1</MarketList> <TotalRows>1</TotalRows> <TotalRowsSelect>1</TotalRowsSelect> </BurnConfirmPeriodResponse>