POST api/analytics/FavoriteProductGoods

Получение статистики по выбираемым товарам за периоды в механике "Любимый продукт"

Request Information

URI Parameters

None.

Body Parameters

FavoriteProductGoodsRequest
NameDescriptionTypeAdditional information
Year

Год, за который выводим данные

integer

None.

Month

Месяц, за который выводим данные

byte

None.

ListData

Идентификатор товара, по которому помесячно в указанном году выводим данные

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Year": 1,
  "Month": 64,
  "ListData": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<FavoriteProductGoodsRequest 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>
  <ListData>1</ListData>
  <Month>64</Month>
  <Year>1</Year>
</FavoriteProductGoodsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FavoriteProductGoodsResponse
NameDescriptionTypeAdditional information
FavGoods

Выбранные товары за месяц

Collection of FavoriteProductGoodsFavGoodsRow

None.

ListDataMonth

Динамика выбора конкретного товара по месяцам указанного года

Collection of FavoriteProductGoodsListDataMonthRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FavGoods": [
    {
      "Id": 1,
      "ListData": 1,
      "Name": "sample string 1",
      "CountSelect": 1
    },
    {
      "Id": 1,
      "ListData": 1,
      "Name": "sample string 1",
      "CountSelect": 1
    }
  ],
  "ListDataMonth": [
    {
      "Id": 1,
      "ProcMonth": 64,
      "Name": "sample string 1",
      "CountSelect": 1,
      "CountClients": 1
    },
    {
      "Id": 1,
      "ProcMonth": 64,
      "Name": "sample string 1",
      "CountSelect": 1,
      "CountClients": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<FavoriteProductGoodsResponse 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>
  <FavGoods>
    <FavoriteProductGoodsResponse.FavoriteProductGoodsFavGoodsRow>
      <CountSelect>1</CountSelect>
      <Id>1</Id>
      <ListData>1</ListData>
      <Name>sample string 1</Name>
    </FavoriteProductGoodsResponse.FavoriteProductGoodsFavGoodsRow>
    <FavoriteProductGoodsResponse.FavoriteProductGoodsFavGoodsRow>
      <CountSelect>1</CountSelect>
      <Id>1</Id>
      <ListData>1</ListData>
      <Name>sample string 1</Name>
    </FavoriteProductGoodsResponse.FavoriteProductGoodsFavGoodsRow>
  </FavGoods>
  <ListDataMonth>
    <FavoriteProductGoodsResponse.FavoriteProductGoodsListDataMonthRow>
      <CountClients>1</CountClients>
      <CountSelect>1</CountSelect>
      <Id>1</Id>
      <Name>sample string 1</Name>
      <ProcMonth>64</ProcMonth>
    </FavoriteProductGoodsResponse.FavoriteProductGoodsListDataMonthRow>
    <FavoriteProductGoodsResponse.FavoriteProductGoodsListDataMonthRow>
      <CountClients>1</CountClients>
      <CountSelect>1</CountSelect>
      <Id>1</Id>
      <Name>sample string 1</Name>
      <ProcMonth>64</ProcMonth>
    </FavoriteProductGoodsResponse.FavoriteProductGoodsListDataMonthRow>
  </ListDataMonth>
</FavoriteProductGoodsResponse>