POST api/bonuses/BonusMarketlistPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

BonusMarketlistPagingInfoRequest
NameDescriptionTypeAdditional information
PosCode

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

string

None.

Name

Входной фильтр: наименование задания на начисление бонусов

string

None.

MarketList

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

integer

None.

BegDate

Входной фильтр: дата начала анализируемого периода

date

None.

EndDate

Входной фильтр: дата окончания анализируемого периода

date

None.

Bonus

Входной фильтр: размер бонуса

decimal number

None.

BonusCard

Входной фильтр: признак, что не реагируем на @bonus, и берём для каждой карты персональный бонус из маркетингового списка или списка карт/клиентов/телефонов

boolean

None.

Source

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

byte

None.

Status

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

byte

None.

Type

Входной фильтр: тип задания для начисления бонусов

byte

None.

OwnerPartner

Входной фильтр: идентификатор партнёра владельца бонусов

integer

None.

OwnerPos

Входной фильтр: идентификатор торговой точки партнера, владельца бонусов

integer

None.

ActiveDate

Входной фильтр: дата активации начисляемого бонуса

date

None.

ExpiryDate

Входной фильтр: дата сгорания начисляемого бонуса

date

None.

BonusMarketList

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

integer

None.

Start

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

integer

None.

Length

Пагинация: количество записей, которые нужно вернуть

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "Name": "sample string 2",
  "MarketList": 1,
  "BegDate": "2024-06-16T12:39:11.822049+03:00",
  "EndDate": "2024-06-16T12:39:11.822049+03:00",
  "Bonus": 1.0,
  "BonusCard": true,
  "Source": 64,
  "Status": 64,
  "Type": 64,
  "OwnerPartner": 1,
  "OwnerPos": 1,
  "ActiveDate": "2024-06-16T12:39:11.822049+03:00",
  "ExpiryDate": "2024-06-16T12:39:11.822049+03:00",
  "BonusMarketList": 1,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<BonusMarketlistPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.BonusesRequest">
  <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>
  <ActiveDate>2024-06-16T12:39:11.822049+03:00</ActiveDate>
  <BegDate>2024-06-16T12:39:11.822049+03:00</BegDate>
  <Bonus>1</Bonus>
  <BonusCard>true</BonusCard>
  <BonusMarketList>1</BonusMarketList>
  <EndDate>2024-06-16T12:39:11.822049+03:00</EndDate>
  <ExpiryDate>2024-06-16T12:39:11.822049+03:00</ExpiryDate>
  <Length>1</Length>
  <MarketList>1</MarketList>
  <Name>sample string 2</Name>
  <OwnerPartner>1</OwnerPartner>
  <OwnerPos>1</OwnerPos>
  <PosCode>sample string 1</PosCode>
  <Source>64</Source>
  <Start>1</Start>
  <Status>64</Status>
  <Type>64</Type>
</BonusMarketlistPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BonusMarketlistPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

BonusList

Массив бонусов

Collection of BonusMarketlistPagingInfoBonusListStr

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "BonusList": [
    {
      "Id": 1,
      "BonusMarketListId": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-06-16T12:39:11.9626747+03:00",
      "BegDate": "2024-06-16T12:39:11.9626747+03:00",
      "MarketList": 1,
      "BonusCard": true,
      "Bonus": 1.0,
      "BonusSource": 64,
      "BonusSourceName": "sample string 2",
      "Type": 64,
      "TypeName": "sample string 3",
      "Status": 64,
      "StatusName": "sample string 4",
      "ActiveDate": "2024-06-16T12:39:11.9626747+03:00",
      "ExpiryDate": "2024-06-16T12:39:11.9626747+03:00",
      "PosOwner": 1,
      "PartnerOwner": 1,
      "CountCard": 1,
      "CommunicationId": 1,
      "CommunicationName": "sample string 5",
      "MarketListName": "sample string 6"
    },
    {
      "Id": 1,
      "BonusMarketListId": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-06-16T12:39:11.9626747+03:00",
      "BegDate": "2024-06-16T12:39:11.9626747+03:00",
      "MarketList": 1,
      "BonusCard": true,
      "Bonus": 1.0,
      "BonusSource": 64,
      "BonusSourceName": "sample string 2",
      "Type": 64,
      "TypeName": "sample string 3",
      "Status": 64,
      "StatusName": "sample string 4",
      "ActiveDate": "2024-06-16T12:39:11.9626747+03:00",
      "ExpiryDate": "2024-06-16T12:39:11.9626747+03:00",
      "PosOwner": 1,
      "PartnerOwner": 1,
      "CountCard": 1,
      "CommunicationId": 1,
      "CommunicationName": "sample string 5",
      "MarketListName": "sample string 6"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<BonusMarketlistPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.BonusesResponse">
  <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>
  <BonusList>
    <BonusMarketlistPagingInfoResponse.BonusMarketlistPagingInfoBonusListStr>
      <ActiveDate>2024-06-16T12:39:11.9626747+03:00</ActiveDate>
      <BegDate>2024-06-16T12:39:11.9626747+03:00</BegDate>
      <Bonus>1</Bonus>
      <BonusCard>true</BonusCard>
      <BonusMarketListId>1</BonusMarketListId>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 2</BonusSourceName>
      <CommunicationId>1</CommunicationId>
      <CommunicationName>sample string 5</CommunicationName>
      <CountCard>1</CountCard>
      <ExpiryDate>2024-06-16T12:39:11.9626747+03:00</ExpiryDate>
      <Id>1</Id>
      <MarketList>1</MarketList>
      <MarketListName>sample string 6</MarketListName>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PartnerOwner>1</PartnerOwner>
      <PosOwner>1</PosOwner>
      <ProcTime>2024-06-16T12:39:11.9626747+03:00</ProcTime>
      <Status>64</Status>
      <StatusName>sample string 4</StatusName>
      <Type>64</Type>
      <TypeName>sample string 3</TypeName>
    </BonusMarketlistPagingInfoResponse.BonusMarketlistPagingInfoBonusListStr>
    <BonusMarketlistPagingInfoResponse.BonusMarketlistPagingInfoBonusListStr>
      <ActiveDate>2024-06-16T12:39:11.9626747+03:00</ActiveDate>
      <BegDate>2024-06-16T12:39:11.9626747+03:00</BegDate>
      <Bonus>1</Bonus>
      <BonusCard>true</BonusCard>
      <BonusMarketListId>1</BonusMarketListId>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 2</BonusSourceName>
      <CommunicationId>1</CommunicationId>
      <CommunicationName>sample string 5</CommunicationName>
      <CountCard>1</CountCard>
      <ExpiryDate>2024-06-16T12:39:11.9626747+03:00</ExpiryDate>
      <Id>1</Id>
      <MarketList>1</MarketList>
      <MarketListName>sample string 6</MarketListName>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PartnerOwner>1</PartnerOwner>
      <PosOwner>1</PosOwner>
      <ProcTime>2024-06-16T12:39:11.9626747+03:00</ProcTime>
      <Status>64</Status>
      <StatusName>sample string 4</StatusName>
      <Type>64</Type>
      <TypeName>sample string 3</TypeName>
    </BonusMarketlistPagingInfoResponse.BonusMarketlistPagingInfoBonusListStr>
  </BonusList>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</BonusMarketlistPagingInfoResponse>