POST api/values/ChequeAggregation

Статистика по чекам за период

Request Information

URI Parameters

None.

Body Parameters

ChequeAggregationRequest
NameDescriptionTypeAdditional information
Operator

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

integer

None.

Partner

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

integer

None.

Pos

код Торговой точки

string

None.

From

Начало периода

date

None.

To

окончание периода

date

None.

Layout

форма агрегирования

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Operator": 1,
  "Partner": 1,
  "Pos": "sample string 2",
  "From": "2022-08-16T21:45:50.25+03:00",
  "To": "2022-08-16T21:45:50.25+03:00",
  "Layout": 3
}

application/xml, text/xml

Sample:
<ChequeAggregationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <From>2022-08-16T21:45:50.25+03:00</From>
  <Layout>3</Layout>
  <Operator>1</Operator>
  <Partner>1</Partner>
  <Pos>sample string 2</Pos>
  <To>2022-08-16T21:45:50.25+03:00</To>
</ChequeAggregationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChequeAggregationResponse
NameDescriptionTypeAdditional information
ChequeInfo

Collection of ChequeAggregation

None.

ErrorCode

код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ChequeInfo": [
    {
      "Amount": 1.0,
      "BonusAdded": 2.0,
      "BonusRedeemed": 3.0,
      "ChequeQty": 4,
      "ChequeQtyWithoutRefund": 5,
      "MonthWeekNum": 1,
      "ChequeDate": "2022-08-16T21:45:50.3906163+03:00"
    },
    {
      "Amount": 1.0,
      "BonusAdded": 2.0,
      "BonusRedeemed": 3.0,
      "ChequeQty": 4,
      "ChequeQtyWithoutRefund": 5,
      "MonthWeekNum": 1,
      "ChequeDate": "2022-08-16T21:45:50.3906163+03:00"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ChequeAggregationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <ChequeInfo>
    <ChequeAggregation>
      <Amount>1</Amount>
      <BonusAdded>2</BonusAdded>
      <BonusRedeemed>3</BonusRedeemed>
      <ChequeDate>2022-08-16T21:45:50.3906163+03:00</ChequeDate>
      <ChequeQty>4</ChequeQty>
      <ChequeQtyWithoutRefund>5</ChequeQtyWithoutRefund>
      <MonthWeekNum>1</MonthWeekNum>
    </ChequeAggregation>
    <ChequeAggregation>
      <Amount>1</Amount>
      <BonusAdded>2</BonusAdded>
      <BonusRedeemed>3</BonusRedeemed>
      <ChequeDate>2022-08-16T21:45:50.3906163+03:00</ChequeDate>
      <ChequeQty>4</ChequeQty>
      <ChequeQtyWithoutRefund>5</ChequeQtyWithoutRefund>
      <MonthWeekNum>1</MonthWeekNum>
    </ChequeAggregation>
  </ChequeInfo>
  <ErrorCode>1</ErrorCode>
  <Message>sample string 2</Message>
</ChequeAggregationResponse>