POST api/analytics/DynamicBonus

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

Request Information

URI Parameters

None.

Body Parameters

DynamicBonusRequest
NameDescriptionTypeAdditional information
BonusSource

Входной фильтр: идентификатор источника начисления

 byte

None.
Pos

Входной фильтр: идентификатор точки продаж, по которой нужно вернуть данные (не задаётся с partner)

 integer

None.
Partner

Входной фильтр: идентификатор партнера, по которому нужно данные (не задаётся с pos)

 integer

None.
Year

Входной фильтр: год, за который нужно вернуть данные

 integer

None.
Month

Входной фильтр: месяц, за который нужно вернуть данные

 byte

None.
AllYear

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

 boolean

None.
BegMonth

Входной фильтр: начальный месяц периода

 byte

None.
EndMonth

Входной фильтр: конечный месяц периода

 byte

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "BonusSource": 64,
  "Pos": 1,
  "Partner": 1,
  "Year": 1,
  "Month": 64,
  "AllYear": true,
  "BegMonth": 64,
  "EndMonth": 64,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample: 
<DynamicBonusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.AnalyticsRequest">
  <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 1</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <AllYear>true</AllYear>
  <BegMonth>64</BegMonth>
  <BonusSource>64</BonusSource>
  <EndMonth>64</EndMonth>
  <Month>64</Month>
  <Partner>1</Partner>
  <Pos>1</Pos>
  <Year>1</Year>
</DynamicBonusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DynamicBonusResponse
NameDescriptionTypeAdditional information
RedeemPersent

Процент списания бонусов от начисленных

 decimal number

None.
BurnPersent

Процент сгорания бонусов от начисленных

 decimal number

None.
AvgRedeem

Средний размер списания бонусов

 decimal number

None.
AvgBurn

Средний размер сгорания бонусов

 decimal number

None.
Total

Массив с данными

 Collection of DynamicBonusTotalRow

None.
Sources

Массив возможных фильтров по источникам бонусов

 Collection of DynamicBonusSource

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "RedeemPersent": 1.0,
  "BurnPersent": 1.0,
  "AvgRedeem": 1.0,
  "AvgBurn": 1.0,
  "Total": [
    {
      "Id": 1,
      "ProcYear": 1,
      "ProcMonth": 64,
      "BonusSource": 64,
      "BonusSourceName": "sample string 1",
      "Added": 1.0,
      "Redeemed": 1.0,
      "Burn": 1.0,
      "Remain": 1.0
    },
    {
      "Id": 1,
      "ProcYear": 1,
      "ProcMonth": 64,
      "BonusSource": 64,
      "BonusSourceName": "sample string 1",
      "Added": 1.0,
      "Redeemed": 1.0,
      "Burn": 1.0,
      "Remain": 1.0
    }
  ],
  "Sources": [
    {
      "Id": 64,
      "BonusSource": 64,
      "BonusSourceName": "sample string 1"
    },
    {
      "Id": 64,
      "BonusSource": 64,
      "BonusSourceName": "sample string 1"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<DynamicBonusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.AnalyticsResponse">
  <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>
  <AvgBurn>1</AvgBurn>
  <AvgRedeem>1</AvgRedeem>
  <BurnPersent>1</BurnPersent>
  <RedeemPersent>1</RedeemPersent>
  <Sources>
    <DynamicBonusResponse.DynamicBonusSource>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 1</BonusSourceName>
      <Id>64</Id>
    </DynamicBonusResponse.DynamicBonusSource>
    <DynamicBonusResponse.DynamicBonusSource>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 1</BonusSourceName>
      <Id>64</Id>
    </DynamicBonusResponse.DynamicBonusSource>
  </Sources>
  <Total>
    <DynamicBonusResponse.DynamicBonusTotalRow>
      <Added>1</Added>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 1</BonusSourceName>
      <Burn>1</Burn>
      <Id>1</Id>
      <ProcMonth>64</ProcMonth>
      <ProcYear>1</ProcYear>
      <Redeemed>1</Redeemed>
      <Remain>1</Remain>
    </DynamicBonusResponse.DynamicBonusTotalRow>
    <DynamicBonusResponse.DynamicBonusTotalRow>
      <Added>1</Added>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 1</BonusSourceName>
      <Burn>1</Burn>
      <Id>1</Id>
      <ProcMonth>64</ProcMonth>
      <ProcYear>1</ProcYear>
      <Redeemed>1</Redeemed>
      <Remain>1</Remain>
    </DynamicBonusResponse.DynamicBonusTotalRow>
  </Total>
</DynamicBonusResponse>