POST api/analytics/TotalPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

TotalPagingInfoRequest
NameDescriptionTypeAdditional information
Partner

Идентификатор партнера, по точкам которого нужно вернуть данные

 integer

None.
Pos

Идентификатор точки продаж, по которой нужно вернуть данные

 integer

None.
PartnerName

Наименование партнера, по точкам которого нужно вернуть данные

 string

None.
PosName

Наименование точки продаж, по которой нужно вернуть данные

 string

None.
Year

Год, за который нужно вернуть данные

 integer

None.
AllYear

Признак, что данные нужно вернуть за все года

 boolean

None.
Month

Месяц, за который нужно вернуть данные

 byte

None.
BegMonth

Начальный месяц периода

 byte

None.
EndMonth

Конечный месяц периода

 byte

None.
Start

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

 integer

None.
Length

Количество записей, которые нужно вернуть

 integer

None.
Report

Признак, что это отчёт

 boolean

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Partner": 1,
  "Pos": 1,
  "PartnerName": "sample string 1",
  "PosName": "sample string 2",
  "Year": 1,
  "AllYear": true,
  "Month": 64,
  "BegMonth": 64,
  "EndMonth": 64,
  "Start": 1,
  "Length": 1,
  "Report": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<TotalPagingInfoRequest 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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <AllYear>true</AllYear>
  <BegMonth>64</BegMonth>
  <EndMonth>64</EndMonth>
  <Length>1</Length>
  <Month>64</Month>
  <Partner>1</Partner>
  <PartnerName>sample string 1</PartnerName>
  <Pos>1</Pos>
  <PosName>sample string 2</PosName>
  <Report>true</Report>
  <Start>1</Start>
  <Year>1</Year>
</TotalPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TotalPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей, которые попали в выборку

 integer

None.
TotalRowsSelect

Количество записей, которые вернулись в массиве ответа на запрос

 integer

None.
Total

Массив с информацией

 Collection of TotalPagingInfoTotalRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Total": [
    {
      "Id": 1,
      "Partner": 1,
      "Pos": 1,
      "PartnerName": "sample string 1",
      "PosName": "sample string 2",
      "Purchases": 1,
      "RefundCount": 1,
      "Gain": 1.0,
      "RefundSum": 1.0,
      "NewClients": 1,
      "UniqueClients": 1,
      "Redeemed": 1.0,
      "RedeemCount": 1,
      "RedeemedAlien": 1.0,
      "Added": 1.0,
      "DiscountSum": 1.0,
      "SertRedeemSum": 1.0,
      "SertRedeemCount": 1
    },
    {
      "Id": 1,
      "Partner": 1,
      "Pos": 1,
      "PartnerName": "sample string 1",
      "PosName": "sample string 2",
      "Purchases": 1,
      "RefundCount": 1,
      "Gain": 1.0,
      "RefundSum": 1.0,
      "NewClients": 1,
      "UniqueClients": 1,
      "Redeemed": 1.0,
      "RedeemCount": 1,
      "RedeemedAlien": 1.0,
      "Added": 1.0,
      "DiscountSum": 1.0,
      "SertRedeemSum": 1.0,
      "SertRedeemCount": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<TotalPagingInfoResponse 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>
  <Total>
    <TotalPagingInfoResponse.TotalPagingInfoTotalRow>
      <Added>1</Added>
      <DiscountSum>1</DiscountSum>
      <Gain>1</Gain>
      <Id>1</Id>
      <NewClients>1</NewClients>
      <Partner>1</Partner>
      <PartnerName>sample string 1</PartnerName>
      <Pos>1</Pos>
      <PosName>sample string 2</PosName>
      <Purchases>1</Purchases>
      <RedeemCount>1</RedeemCount>
      <Redeemed>1</Redeemed>
      <RedeemedAlien>1</RedeemedAlien>
      <RefundCount>1</RefundCount>
      <RefundSum>1</RefundSum>
      <SertRedeemCount>1</SertRedeemCount>
      <SertRedeemSum>1</SertRedeemSum>
      <UniqueClients>1</UniqueClients>
    </TotalPagingInfoResponse.TotalPagingInfoTotalRow>
    <TotalPagingInfoResponse.TotalPagingInfoTotalRow>
      <Added>1</Added>
      <DiscountSum>1</DiscountSum>
      <Gain>1</Gain>
      <Id>1</Id>
      <NewClients>1</NewClients>
      <Partner>1</Partner>
      <PartnerName>sample string 1</PartnerName>
      <Pos>1</Pos>
      <PosName>sample string 2</PosName>
      <Purchases>1</Purchases>
      <RedeemCount>1</RedeemCount>
      <Redeemed>1</Redeemed>
      <RedeemedAlien>1</RedeemedAlien>
      <RefundCount>1</RefundCount>
      <RefundSum>1</RefundSum>
      <SertRedeemCount>1</SertRedeemCount>
      <SertRedeemSum>1</SertRedeemSum>
      <UniqueClients>1</UniqueClients>
    </TotalPagingInfoResponse.TotalPagingInfoTotalRow>
  </Total>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</TotalPagingInfoResponse>