POST api/bonuses/BurnActivePeriod

Получение информации о клиентах, у которых в заданный промежуток времени сгорят бонусы и/или активируются бонусы

Request Information

URI Parameters

None.

Body Parameters

BurnActivePeriodRequest
NameDescriptionTypeAdditional information
Partner

Идентификатор партнера пользователя

integer

None.

PosCode

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

string

None.

Client

Идентификатор клиента, по которому нужно вернуть детализацию

integer

None.

Card

Номер карты клиента, по которой нужно вернуть детализацию

integer

None.

BegDate

Дата начала периода анализа сгораемых бонусов

date

None.

EndDate

Дата конца периода анализа сгораемых бонусов

date

None.

CountDaysAfter

Количество дней от сегодня ("завтра" = 1), через которое сгорят бонусы (не в течение которых, а через которое)

integer

None.

MarketListCreate

Признак, создавать или нет из результатов выборки маркетинговый список карт

boolean

None.

Burn

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

boolean

None.

Active

Фильтр: возвращаем только бонусы, которые активируются

boolean

None.

LimitBonusBurnMore

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

decimal number

None.

LimitBonusActiveMore

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

decimal number

None.

BonusSource

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

byte

None.

BonusSourceList

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

integer

None.

Start

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

integer

None.

Lenght

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Partner": 1,
  "PosCode": "sample string 1",
  "Client": 1,
  "Card": 1,
  "BegDate": "2024-06-15T00:55:42.4746832+03:00",
  "EndDate": "2024-06-15T00:55:42.4746832+03:00",
  "CountDaysAfter": 1,
  "MarketListCreate": true,
  "Burn": true,
  "Active": true,
  "LimitBonusBurnMore": 1.0,
  "LimitBonusActiveMore": 1.0,
  "BonusSource": 64,
  "BonusSourceList": 1,
  "Start": 1,
  "Lenght": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<BurnActivePeriodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.BonusesRequest">
  <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>
  <Active>true</Active>
  <BegDate>2024-06-15T00:55:42.4746832+03:00</BegDate>
  <BonusSource>64</BonusSource>
  <BonusSourceList>1</BonusSourceList>
  <Burn>true</Burn>
  <Card>1</Card>
  <Client>1</Client>
  <CountDaysAfter>1</CountDaysAfter>
  <EndDate>2024-06-15T00:55:42.4746832+03:00</EndDate>
  <Lenght>1</Lenght>
  <LimitBonusActiveMore>1</LimitBonusActiveMore>
  <LimitBonusBurnMore>1</LimitBonusBurnMore>
  <MarketListCreate>true</MarketListCreate>
  <Partner>1</Partner>
  <PosCode>sample string 1</PosCode>
  <Start>1</Start>
</BurnActivePeriodRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BurnActivePeriodResponse
NameDescriptionTypeAdditional information
Total

Общее кол-во запией, которое попало в выборку

integer

None.

Clients

Массив клиентов

Collection of BurnActivePeriodClient

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Total": 1,
  "Clients": [
    {
      "Client": 1,
      "Phone": 1,
      "Card": 1,
      "ActiveBonus": 1.0,
      "BurnBonus": 1.0,
      "Remain": 1.0
    },
    {
      "Client": 1,
      "Phone": 1,
      "Card": 1,
      "ActiveBonus": 1.0,
      "BurnBonus": 1.0,
      "Remain": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<BurnActivePeriodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.BonusesResponse">
  <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>
  <Clients>
    <BurnActivePeriodResponse.BurnActivePeriodClient>
      <ActiveBonus>1</ActiveBonus>
      <BurnBonus>1</BurnBonus>
      <Card>1</Card>
      <Client>1</Client>
      <Phone>1</Phone>
      <Remain>1</Remain>
    </BurnActivePeriodResponse.BurnActivePeriodClient>
    <BurnActivePeriodResponse.BurnActivePeriodClient>
      <ActiveBonus>1</ActiveBonus>
      <BurnBonus>1</BurnBonus>
      <Card>1</Card>
      <Client>1</Client>
      <Phone>1</Phone>
      <Remain>1</Remain>
    </BurnActivePeriodResponse.BurnActivePeriodClient>
  </Clients>
  <Total>1</Total>
</BurnActivePeriodResponse>