POST api/reports/RedeemEventRuleCouponBonus

Отчёт о списанных купонных бонусах с указанием активности клиентов, в разбивке по точкам продаж, с входными фильтрами

Request Information

URI Parameters

None.

Body Parameters

RedeemEventRuleCouponBonusRequest
NameDescriptionTypeAdditional information
PosRedeem

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

integer

None.

PosListRedeem

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

integer

None.

LlcCompanyNameRedeem

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

string

None.

Coupon

Входной фильтр: наименование купона

string

None.

CouponSeries

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

integer

None.

EventRule

Входной фильтр: идентификатор правила событийного микросервиса

integer

None.

ProcMonth

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

byte

None.

ProcYear

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

integer

None.

Test

Признак тестирования, выводит доп данные

boolean

None.

CouponDetails

Признак, что требуется детализация по купонам

boolean

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosRedeem": 1,
  "PosListRedeem": 1,
  "LlcCompanyNameRedeem": "sample string 1",
  "Coupon": "sample string 2",
  "CouponSeries": 1,
  "EventRule": 1,
  "ProcMonth": 64,
  "ProcYear": 1,
  "Test": true,
  "CouponDetails": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<RedeemEventRuleCouponBonusRequest 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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Coupon>sample string 2</Coupon>
  <CouponDetails>true</CouponDetails>
  <CouponSeries>1</CouponSeries>
  <EventRule>1</EventRule>
  <LlcCompanyNameRedeem>sample string 1</LlcCompanyNameRedeem>
  <PosListRedeem>1</PosListRedeem>
  <PosRedeem>1</PosRedeem>
  <ProcMonth>64</ProcMonth>
  <ProcYear>1</ProcYear>
  <Test>true</Test>
</RedeemEventRuleCouponBonusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RedeemEventRuleCouponBonusReportResponse
NameDescriptionTypeAdditional information
Report

Бинарные данные отчёта

Collection of byte

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Report": "QEA=",
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<RedeemEventRuleCouponBonusReportResponse 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>
  <Report>QEA=</Report>
</RedeemEventRuleCouponBonusReportResponse>