POST api/analytics/TotalPartnerPos

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

Request Information

URI Parameters

None.

Body Parameters

TotalPartnerPosRequest

Name	Description	Type	Additional information
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:

{
  "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:

<TotalPartnerPosRequest 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>
  <EndMonth>64</EndMonth>
  <Month>64</Month>
  <Partner>1</Partner>
  <Pos>1</Pos>
  <Year>1</Year>
</TotalPartnerPosRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TotalPartnerPosResponse

Name	Description	Type	Additional information
Total	Массив с информацией	Collection of TotalPartnerPosTotalRow	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": [
    {
      "Id": 1,
      "ProcMonth": 64,
      "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,
      "AvgCheque": 1.0
    },
    {
      "Id": 1,
      "ProcMonth": 64,
      "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,
      "AvgCheque": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<TotalPartnerPosResponse 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>
    <TotalPartnerPosResponse.TotalPartnerPosTotalRow>
      <Added>1</Added>
      <AvgCheque>1</AvgCheque>
      <DiscountSum>1</DiscountSum>
      <Gain>1</Gain>
      <Id>1</Id>
      <NewClients>1</NewClients>
      <ProcMonth>64</ProcMonth>
      <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>
    </TotalPartnerPosResponse.TotalPartnerPosTotalRow>
    <TotalPartnerPosResponse.TotalPartnerPosTotalRow>
      <Added>1</Added>
      <AvgCheque>1</AvgCheque>
      <DiscountSum>1</DiscountSum>
      <Gain>1</Gain>
      <Id>1</Id>
      <NewClients>1</NewClients>
      <ProcMonth>64</ProcMonth>
      <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>
    </TotalPartnerPosResponse.TotalPartnerPosTotalRow>
  </Total>
</TotalPartnerPosResponse>