POST api/marketing/MarketlistPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

MarketlistPagingInfoRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки пользователя

string

None.

Start

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

integer

None.

Length

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

integer

None.

Date

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

date

None.

BegDate

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

date

None.

EndDate

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

date

None.

MarketListType

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

byte

None.

Name

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

string

None.

MarketList

Входной фильтр: маркетинговый список, по которому нужно вернуть информацию

integer

None.

SampleRule

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "Start": 1,
  "Length": 1,
  "Date": "2024-06-16T12:04:46.9630903+03:00",
  "BegDate": "2024-06-16T12:04:46.9630903+03:00",
  "EndDate": "2024-06-16T12:04:46.9630903+03:00",
  "MarketListType": 64,
  "Name": "sample string 2",
  "MarketList": 1,
  "SampleRule": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<MarketlistPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest">
  <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>
  <BegDate>2024-06-16T12:04:46.9630903+03:00</BegDate>
  <Date>2024-06-16T12:04:46.9630903+03:00</Date>
  <EndDate>2024-06-16T12:04:46.9630903+03:00</EndDate>
  <Length>1</Length>
  <MarketList>1</MarketList>
  <MarketListType>64</MarketListType>
  <Name>sample string 2</Name>
  <PosCode>sample string 1</PosCode>
  <SampleRule>1</SampleRule>
  <Start>1</Start>
</MarketlistPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MarketlistPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей всего

integer

None.

TotalRowsSelect

Количество записей в запросе

integer

None.

Data

Данные

Collection of MarketlistPagingInfoData

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "MarketListId": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-06-16T12:04:47.0880884+03:00",
      "MarketListType": 64,
      "MarketListTypeName": "sample string 2",
      "Description": "sample string 3",
      "SampleRule": 1,
      "SampleRuleName": "sample string 4",
      "CountCard": 1
    },
    {
      "Id": 1,
      "MarketListId": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-06-16T12:04:47.0880884+03:00",
      "MarketListType": 64,
      "MarketListTypeName": "sample string 2",
      "Description": "sample string 3",
      "SampleRule": 1,
      "SampleRuleName": "sample string 4",
      "CountCard": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<MarketlistPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
  <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>
    <MarketlistPagingInfoResponse.MarketlistPagingInfoData>
      <CountCard>1</CountCard>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketListId>1</MarketListId>
      <MarketListType>64</MarketListType>
      <MarketListTypeName>sample string 2</MarketListTypeName>
      <Name>sample string 1</Name>
      <ProcTime>2024-06-16T12:04:47.0880884+03:00</ProcTime>
      <SampleRule>1</SampleRule>
      <SampleRuleName>sample string 4</SampleRuleName>
    </MarketlistPagingInfoResponse.MarketlistPagingInfoData>
    <MarketlistPagingInfoResponse.MarketlistPagingInfoData>
      <CountCard>1</CountCard>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketListId>1</MarketListId>
      <MarketListType>64</MarketListType>
      <MarketListTypeName>sample string 2</MarketListTypeName>
      <Name>sample string 1</Name>
      <ProcTime>2024-06-16T12:04:47.0880884+03:00</ProcTime>
      <SampleRule>1</SampleRule>
      <SampleRuleName>sample string 4</SampleRuleName>
    </MarketlistPagingInfoResponse.MarketlistPagingInfoData>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</MarketlistPagingInfoResponse>