POST api/marketing/CommunicationPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

CommunicationPagingInfoRequest
NameDescriptionTypeAdditional information
PosCode

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

string

None.

OnlyActive

Фильтр: вернуть только активные рассылки (т.е. в любом статусе но не отправленные ещё)

boolean

None.

PartnerSender

Фильтр: признак отправки от имени отправителя партнера, а не оператора

boolean

None.

Name

Фильтр: наименование рассылки

string

None.

CommunicationId

Фильтр: идентификатор рассылки

integer

None.

CommunicationType

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

byte

None.

CommunicationStatus

Фильтр: идентификатор статус рассылки

byte

None.

BegDate

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

date

None.

EndDate

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

date

None.

TextMessage

Фильтр: текст сообщения

string

None.

MessageTemplate

Фильтр: идентификатор ранее созданного шаблона сообщения

integer

None.

MarketList

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

integer

None.

ClientList

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

integer

None.

PersonList

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

integer

None.

Campaign

Фильтр: идентификатор акции, в рамках которой настроена рассылка

integer

None.

Sample

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

integer

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",
  "OnlyActive": true,
  "PartnerSender": true,
  "Name": "sample string 2",
  "CommunicationId": 1,
  "CommunicationType": 64,
  "CommunicationStatus": 64,
  "BegDate": "2024-06-15T01:02:28.6752603+03:00",
  "EndDate": "2024-06-15T01:02:28.6752603+03:00",
  "TextMessage": "sample string 3",
  "MessageTemplate": 1,
  "MarketList": 1,
  "ClientList": 1,
  "PersonList": 1,
  "Campaign": 1,
  "Sample": 1,
  "BonusMarketList": 1,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:
<CommunicationPagingInfoRequest 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 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-06-15T01:02:28.6752603+03:00</BegDate>
  <BonusMarketList>1</BonusMarketList>
  <Campaign>1</Campaign>
  <ClientList>1</ClientList>
  <CommunicationId>1</CommunicationId>
  <CommunicationStatus>64</CommunicationStatus>
  <CommunicationType>64</CommunicationType>
  <EndDate>2024-06-15T01:02:28.6752603+03:00</EndDate>
  <Length>1</Length>
  <MarketList>1</MarketList>
  <MessageTemplate>1</MessageTemplate>
  <Name>sample string 2</Name>
  <OnlyActive>true</OnlyActive>
  <PartnerSender>true</PartnerSender>
  <PersonList>1</PersonList>
  <PosCode>sample string 1</PosCode>
  <Sample>1</Sample>
  <Start>1</Start>
  <TextMessage>sample string 3</TextMessage>
</CommunicationPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommunicationPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

Communication

Полученные по фильтрам рассылки

Collection of CommunicationPagingInfoCommunication

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Communication": [
    {
      "Id": 1,
      "CommunicationId": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "CommunicationType": 64,
      "CommunicationTypeName": "sample string 2",
      "CommunicationStatus": 64,
      "CommunicationStatusName": "sample string 3",
      "BegDate": "2024-06-15T01:02:28.9408853+03:00",
      "EndDate": "2024-06-15T01:02:28.9408853+03:00",
      "Title": "sample string 4",
      "TextMessage": "sample string 5",
      "Image": "sample string 6",
      "TypeOpen": "sample string 7",
      "IdTypeOpen": "sample string 8",
      "MessageTemplate": 1,
      "MarketList": 1,
      "BonusMarketList": 1,
      "PersonList": 1,
      "Campaign": 1,
      "CountSendMessage": 1,
      "MarketListName": "sample string 9",
      "BonusMarketListName": "sample string 10",
      "CommunicationCost": 1.0
    },
    {
      "Id": 1,
      "CommunicationId": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "CommunicationType": 64,
      "CommunicationTypeName": "sample string 2",
      "CommunicationStatus": 64,
      "CommunicationStatusName": "sample string 3",
      "BegDate": "2024-06-15T01:02:28.9408853+03:00",
      "EndDate": "2024-06-15T01:02:28.9408853+03:00",
      "Title": "sample string 4",
      "TextMessage": "sample string 5",
      "Image": "sample string 6",
      "TypeOpen": "sample string 7",
      "IdTypeOpen": "sample string 8",
      "MessageTemplate": 1,
      "MarketList": 1,
      "BonusMarketList": 1,
      "PersonList": 1,
      "Campaign": 1,
      "CountSendMessage": 1,
      "MarketListName": "sample string 9",
      "BonusMarketListName": "sample string 10",
      "CommunicationCost": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CommunicationPagingInfoResponse 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>
  <Communication>
    <CommunicationPagingInfoResponse.CommunicationPagingInfoCommunication>
      <BegDate>2024-06-15T01:02:28.9408853+03:00</BegDate>
      <BonusMarketList>1</BonusMarketList>
      <BonusMarketListName>sample string 10</BonusMarketListName>
      <Campaign>1</Campaign>
      <CommunicationCost>1</CommunicationCost>
      <CommunicationId>1</CommunicationId>
      <CommunicationStatus>64</CommunicationStatus>
      <CommunicationStatusName>sample string 3</CommunicationStatusName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 2</CommunicationTypeName>
      <CountSendMessage>1</CountSendMessage>
      <EndDate>2024-06-15T01:02:28.9408853+03:00</EndDate>
      <Id>1</Id>
      <IdTypeOpen>sample string 8</IdTypeOpen>
      <Image>sample string 6</Image>
      <MarketList>1</MarketList>
      <MarketListName>sample string 9</MarketListName>
      <MessageTemplate>1</MessageTemplate>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PersonList>1</PersonList>
      <TextMessage>sample string 5</TextMessage>
      <Title>sample string 4</Title>
      <TypeOpen>sample string 7</TypeOpen>
    </CommunicationPagingInfoResponse.CommunicationPagingInfoCommunication>
    <CommunicationPagingInfoResponse.CommunicationPagingInfoCommunication>
      <BegDate>2024-06-15T01:02:28.9408853+03:00</BegDate>
      <BonusMarketList>1</BonusMarketList>
      <BonusMarketListName>sample string 10</BonusMarketListName>
      <Campaign>1</Campaign>
      <CommunicationCost>1</CommunicationCost>
      <CommunicationId>1</CommunicationId>
      <CommunicationStatus>64</CommunicationStatus>
      <CommunicationStatusName>sample string 3</CommunicationStatusName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 2</CommunicationTypeName>
      <CountSendMessage>1</CountSendMessage>
      <EndDate>2024-06-15T01:02:28.9408853+03:00</EndDate>
      <Id>1</Id>
      <IdTypeOpen>sample string 8</IdTypeOpen>
      <Image>sample string 6</Image>
      <MarketList>1</MarketList>
      <MarketListName>sample string 9</MarketListName>
      <MessageTemplate>1</MessageTemplate>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PersonList>1</PersonList>
      <TextMessage>sample string 5</TextMessage>
      <Title>sample string 4</Title>
      <TypeOpen>sample string 7</TypeOpen>
    </CommunicationPagingInfoResponse.CommunicationPagingInfoCommunication>
  </Communication>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</CommunicationPagingInfoResponse>