POST api/reports/RedeemBonusSource

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

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BonusSource	Входной фильтр: идентификатор источника начисления	byte	None.
Report	Признак, что нужно вернуть данные для отчёта, а не селект для таблицы	boolean	None.
Pos	Входной фильтр: идентификатор точки продаж, по которой нужно вернуть данные (не задаётся с partner)	integer	None.
Partner	Входной фильтр: идентификатор партнера, по которому нужно данные (не задаётся с pos)	integer	None.
Year	Входной фильтр: год, за который нужно вернуть данные	integer	None.
Month	Входной фильтр: месяц, за который нужно вернуть данные	byte	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,
  "Report": true,
  "Pos": 1,
  "Partner": 1,
  "Year": 1,
  "Month": 64,
  "BegMonth": 64,
  "EndMonth": 64,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:

<RedeemBonusSourceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.ReportsRequest">
  <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>
  <BegMonth>64</BegMonth>
  <BonusSource>64</BonusSource>
  <EndMonth>64</EndMonth>
  <Month>64</Month>
  <Partner>1</Partner>
  <Pos>1</Pos>
  <Report>true</Report>
  <Year>1</Year>
</RedeemBonusSourceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RedeemBonusSourceResponse

Name	Description	Type	Additional information
Report	Бинарные данные отчёта	Collection of byte	None.
PosBonusData	Итоговая информация	Collection of RedeemBonusSourcePosBonusDataRow	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Report": "QEA=",
  "PosBonusData": [
    {
      "Id": 1,
      "Pos": 1,
      "PosName": "sample string 1",
      "LlcIpCompany": "sample string 2",
      "CityName": "sample string 3",
      "Added": 1.0,
      "Redeemed": 1.0,
      "Burn": 1.0,
      "GainClients": 1.0,
      "ClientWithPurchases": 1,
      "ClientWithRedeem": 1,
      "AvgCheque": 1.0
    },
    {
      "Id": 1,
      "Pos": 1,
      "PosName": "sample string 1",
      "LlcIpCompany": "sample string 2",
      "CityName": "sample string 3",
      "Added": 1.0,
      "Redeemed": 1.0,
      "Burn": 1.0,
      "GainClients": 1.0,
      "ClientWithPurchases": 1,
      "ClientWithRedeem": 1,
      "AvgCheque": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<RedeemBonusSourceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ReportsResponse">
  <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>
  <PosBonusData>
    <RedeemBonusSourceResponse.RedeemBonusSourcePosBonusDataRow>
      <Added>1</Added>
      <AvgCheque>1</AvgCheque>
      <Burn>1</Burn>
      <CityName>sample string 3</CityName>
      <ClientWithPurchases>1</ClientWithPurchases>
      <ClientWithRedeem>1</ClientWithRedeem>
      <GainClients>1</GainClients>
      <Id>1</Id>
      <LlcIpCompany>sample string 2</LlcIpCompany>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Redeemed>1</Redeemed>
    </RedeemBonusSourceResponse.RedeemBonusSourcePosBonusDataRow>
    <RedeemBonusSourceResponse.RedeemBonusSourcePosBonusDataRow>
      <Added>1</Added>
      <AvgCheque>1</AvgCheque>
      <Burn>1</Burn>
      <CityName>sample string 3</CityName>
      <ClientWithPurchases>1</ClientWithPurchases>
      <ClientWithRedeem>1</ClientWithRedeem>
      <GainClients>1</GainClients>
      <Id>1</Id>
      <LlcIpCompany>sample string 2</LlcIpCompany>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Redeemed>1</Redeemed>
    </RedeemBonusSourceResponse.RedeemBonusSourcePosBonusDataRow>
  </PosBonusData>
  <Report>QEA=</Report>
</RedeemBonusSourceResponse>