POST api/cheque/ChequeRulePagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

ChequeRulePagingInfoRequest
NameDescriptionTypeAdditional information
Active

Фильтр: вернуть только активные правила

boolean

None.

NoActive

Фильтр: вернуть только НЕактивные правила

boolean

None.

Name

Фильтр: наименование правила

string

None.

ChequeRuleId

Фильтр: идентификатор правила

integer

None.

ChequeRuleType

Фильтр: идентификатор типа правила

byte

None.

ChequeRuleSpecies

Фильтр: идентификатор вида правила

byte

None.

BegDate

Фильтр: дата начала анализируемого периода действия правила

date

None.

EndDate

Фильтр: дата окончания анализируемого периода действия правила

date

None.

Tracking

Фильтр: признак "отслеживания" на правиле

boolean

None.

ForCheque

Фильтр: признак действия правила "на чек", а не на позицию

boolean

None.

MarketList

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

integer

None.

BirthdayRule

Фильтр: дата окончания анализируемого периода действия правила

boolean

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:
{
  "Active": true,
  "NoActive": true,
  "Name": "sample string 1",
  "ChequeRuleId": 1,
  "ChequeRuleType": 64,
  "ChequeRuleSpecies": 64,
  "BegDate": "2024-06-16T11:41:28.9102423+03:00",
  "EndDate": "2024-06-16T11:41:28.9102423+03:00",
  "Tracking": true,
  "ForCheque": true,
  "MarketList": 1,
  "BirthdayRule": true,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<ChequeRulePagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.ChequeRequest">
  <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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Active>true</Active>
  <BegDate>2024-06-16T11:41:28.9102423+03:00</BegDate>
  <BirthdayRule>true</BirthdayRule>
  <ChequeRuleId>1</ChequeRuleId>
  <ChequeRuleSpecies>64</ChequeRuleSpecies>
  <ChequeRuleType>64</ChequeRuleType>
  <EndDate>2024-06-16T11:41:28.9102423+03:00</EndDate>
  <ForCheque>true</ForCheque>
  <Length>1</Length>
  <MarketList>1</MarketList>
  <Name>sample string 1</Name>
  <NoActive>true</NoActive>
  <Start>1</Start>
  <Tracking>true</Tracking>
</ChequeRulePagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChequeRulePagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

Data

Массив правил

Collection of ChequeRulePagingInfoRuleDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "ChequeRuleId": 1,
      "Operator": 1,
      "Active": true,
      "Interest": 1.0,
      "Fixed": 1.0,
      "Tracking": true,
      "Name": "sample string 1",
      "ChequeRuleType": 64,
      "ChequeRuleTypeName": "sample string 2",
      "ChequeRuleSpecies": 64,
      "ChequeRuleSpeciesName": "sample string 3",
      "BegDate": "2024-06-16T11:41:28.9258684+03:00",
      "EndDate": "2024-06-16T11:41:28.9258684+03:00",
      "MarketList": 1,
      "MarketListName": "sample string 4"
    },
    {
      "Id": 1,
      "ChequeRuleId": 1,
      "Operator": 1,
      "Active": true,
      "Interest": 1.0,
      "Fixed": 1.0,
      "Tracking": true,
      "Name": "sample string 1",
      "ChequeRuleType": 64,
      "ChequeRuleTypeName": "sample string 2",
      "ChequeRuleSpecies": 64,
      "ChequeRuleSpeciesName": "sample string 3",
      "BegDate": "2024-06-16T11:41:28.9258684+03:00",
      "EndDate": "2024-06-16T11:41:28.9258684+03:00",
      "MarketList": 1,
      "MarketListName": "sample string 4"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ChequeRulePagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ChequeResponse">
  <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>
  <Data>
    <ChequeRulePagingInfoResponse.ChequeRulePagingInfoRuleDataRow>
      <Active>true</Active>
      <BegDate>2024-06-16T11:41:28.9258684+03:00</BegDate>
      <ChequeRuleId>1</ChequeRuleId>
      <ChequeRuleSpecies>64</ChequeRuleSpecies>
      <ChequeRuleSpeciesName>sample string 3</ChequeRuleSpeciesName>
      <ChequeRuleType>64</ChequeRuleType>
      <ChequeRuleTypeName>sample string 2</ChequeRuleTypeName>
      <EndDate>2024-06-16T11:41:28.9258684+03:00</EndDate>
      <Fixed>1</Fixed>
      <Id>1</Id>
      <Interest>1</Interest>
      <MarketList>1</MarketList>
      <MarketListName>sample string 4</MarketListName>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <Tracking>true</Tracking>
    </ChequeRulePagingInfoResponse.ChequeRulePagingInfoRuleDataRow>
    <ChequeRulePagingInfoResponse.ChequeRulePagingInfoRuleDataRow>
      <Active>true</Active>
      <BegDate>2024-06-16T11:41:28.9258684+03:00</BegDate>
      <ChequeRuleId>1</ChequeRuleId>
      <ChequeRuleSpecies>64</ChequeRuleSpecies>
      <ChequeRuleSpeciesName>sample string 3</ChequeRuleSpeciesName>
      <ChequeRuleType>64</ChequeRuleType>
      <ChequeRuleTypeName>sample string 2</ChequeRuleTypeName>
      <EndDate>2024-06-16T11:41:28.9258684+03:00</EndDate>
      <Fixed>1</Fixed>
      <Id>1</Id>
      <Interest>1</Interest>
      <MarketList>1</MarketList>
      <MarketListName>sample string 4</MarketListName>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <Tracking>true</Tracking>
    </ChequeRulePagingInfoResponse.ChequeRulePagingInfoRuleDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ChequeRulePagingInfoResponse>