POST api/marketing/Communications
Получение информации о рассылках, доступных для отображения пользователю, который осуществляет запрос
Request Information
URI Parameters
None.
Body Parameters
CommunicationsRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
OperatorCommunication |
Идентификатор оператора, которому принадлежит рассылка |
integer |
None. |
OnlyActive |
Фильтр: вернуть только активные рассылки (т.е. в любом статусе но не отправленные ещё) |
boolean |
None. |
PartnerSender |
Фильтр: признак отправки от имени отправителя партнера, а не оператора |
boolean |
None. |
Name |
Фильтр: наименование рассылки |
string |
None. |
CommunicationType |
Фильтр: идентификатор типа рассылки |
byte |
None. |
CommunicationStatus |
Фильтр: идентификатор статус рассылки |
byte |
None. |
BegDate |
Фильтр: дата начала анализируемого периода |
date |
None. |
EndDate |
Фильтр: дата окончания анализируемого периода |
date |
None. |
Title |
Фильтр: заголовок сообщения |
string |
None. |
TextMessage |
Фильтр: текст сообщения |
string |
None. |
MessageTemplate |
Фильтр: идентификатор ранее созданного шаблона сообщения |
integer |
None. |
MarketList |
Фильтр: идентификатор ранее созданного списка карт |
integer |
None. |
ClientList |
Фильтр: идентификатор ранее созданного списка клиентов |
integer |
None. |
Campaign |
Фильтр: идентификатор акции, в рамках которой настроена рассылка |
integer |
None. |
Sample |
Фильтр: идентификатор выборки клиентов, по которым настроена рассылка |
integer |
None. |
BonusListRule |
Идентификатор правила начисления бонусов на список клиентов |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "OperatorCommunication": 1, "OnlyActive": true, "PartnerSender": true, "Name": "sample string 2", "CommunicationType": 64, "CommunicationStatus": 64, "BegDate": "2022-08-19T22:46:16.3625991+03:00", "EndDate": "2022-08-19T22:46:16.3625991+03:00", "Title": "sample string 3", "TextMessage": "sample string 4", "MessageTemplate": 1, "MarketList": 1, "ClientList": 1, "Campaign": 1, "Sample": 1, "BonusListRule": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 5" }
application/xml, text/xml
<CommunicationsRequest 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 5</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <BegDate>2022-08-19T22:46:16.3625991+03:00</BegDate> <BonusListRule>1</BonusListRule> <Campaign>1</Campaign> <ClientList>1</ClientList> <CommunicationStatus>64</CommunicationStatus> <CommunicationType>64</CommunicationType> <EndDate>2022-08-19T22:46:16.3625991+03:00</EndDate> <MarketList>1</MarketList> <MessageTemplate>1</MessageTemplate> <Name>sample string 2</Name> <OnlyActive>true</OnlyActive> <OperatorCommunication>1</OperatorCommunication> <PartnerSender>true</PartnerSender> <PosCode>sample string 1</PosCode> <Sample>1</Sample> <TextMessage>sample string 4</TextMessage> <Title>sample string 3</Title> </CommunicationsRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CommunicationsResponseName | Description | Type | Additional information |
---|---|---|---|
Count |
Колчество записей |
integer |
None. |
Communication |
Полученные по фильтрам рассылки |
Collection of CommunicationsCommunication |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Count": 1, "Communication": [ { "Operator": 1, "Name": "sample string 1", "CommunicationType": 64, "CommunicationTypeName": "sample string 2", "CommunicationStatus": 64, "CommunicationStatusName": "sample string 3", "BegDate": "2022-08-19T22:46:16.6282195+03:00", "EndDate": "2022-08-19T22:46:16.6282195+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, "Campaign": 1, "CountSendMessage": 1 }, { "Operator": 1, "Name": "sample string 1", "CommunicationType": 64, "CommunicationTypeName": "sample string 2", "CommunicationStatus": 64, "CommunicationStatusName": "sample string 3", "BegDate": "2022-08-19T22:46:16.6282195+03:00", "EndDate": "2022-08-19T22:46:16.6282195+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, "Campaign": 1, "CountSendMessage": 1 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<CommunicationsResponse 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> <CommunicationsResponse.CommunicationsCommunication> <BegDate>2022-08-19T22:46:16.6282195+03:00</BegDate> <Campaign>1</Campaign> <CommunicationStatus>64</CommunicationStatus> <CommunicationStatusName>sample string 3</CommunicationStatusName> <CommunicationType>64</CommunicationType> <CommunicationTypeName>sample string 2</CommunicationTypeName> <CountSendMessage>1</CountSendMessage> <EndDate>2022-08-19T22:46:16.6282195+03:00</EndDate> <IdTypeOpen>sample string 8</IdTypeOpen> <Image>sample string 6</Image> <MarketList>1</MarketList> <MessageTemplate>1</MessageTemplate> <Name>sample string 1</Name> <Operator>1</Operator> <TextMessage>sample string 5</TextMessage> <Title>sample string 4</Title> <TypeOpen>sample string 7</TypeOpen> </CommunicationsResponse.CommunicationsCommunication> <CommunicationsResponse.CommunicationsCommunication> <BegDate>2022-08-19T22:46:16.6282195+03:00</BegDate> <Campaign>1</Campaign> <CommunicationStatus>64</CommunicationStatus> <CommunicationStatusName>sample string 3</CommunicationStatusName> <CommunicationType>64</CommunicationType> <CommunicationTypeName>sample string 2</CommunicationTypeName> <CountSendMessage>1</CountSendMessage> <EndDate>2022-08-19T22:46:16.6282195+03:00</EndDate> <IdTypeOpen>sample string 8</IdTypeOpen> <Image>sample string 6</Image> <MarketList>1</MarketList> <MessageTemplate>1</MessageTemplate> <Name>sample string 1</Name> <Operator>1</Operator> <TextMessage>sample string 5</TextMessage> <Title>sample string 4</Title> <TypeOpen>sample string 7</TypeOpen> </CommunicationsResponse.CommunicationsCommunication> </Communication> <Count>1</Count> </CommunicationsResponse>