POST api/marketing/MessageTemplatePagingInfo
Получение информации о шаблонах сообщений Оператора, с входными фильтрами и пагинацией
Request Information
URI Parameters
None.
Body Parameters
MessageTemplatePagingInfoRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PosCode |
Код торговой точки пользователя |
string |
None. |
| MessageTemplateId |
Идентификатор шаблона, для изменения или получения информации |
integer |
None. |
| EventType |
Тип евента (события) для шаблона |
integer |
None. |
| CommunicationType |
Тип коммуникации в шаблоне |
byte |
None. |
| Active |
Статус активности шаблона |
boolean |
None. |
| NoActive |
Статус неактивности шаблона |
boolean |
None. |
| CommunicationCodeType |
Идентификатор типа кода (авторизация, списание, замена карты и т.д), который отправляется по данному шаблону |
byte |
None. |
| TemplateText |
Текст шаблона сообщения |
string |
None. |
| Start |
Пагинация: номер записи, от которой показывать записи, включая указанную |
integer |
None. |
| Length |
Пагинация: позиция от которой показывать записи, включая указанную |
integer |
None. |
| Name |
Пользовательское наименование шаблона |
string |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"PosCode": "sample string 1",
"MessageTemplateId": 1,
"EventType": 1,
"CommunicationType": 64,
"Active": true,
"NoActive": true,
"CommunicationCodeType": 64,
"TemplateText": "sample string 2",
"Start": 1,
"Length": 1,
"Name": "sample string 3",
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 4"
}
application/xml, text/xml
<MessageTemplatePagingInfoRequest 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> <Active>true</Active> <CommunicationCodeType>64</CommunicationCodeType> <CommunicationType>64</CommunicationType> <EventType>1</EventType> <Length>1</Length> <MessageTemplateId>1</MessageTemplateId> <Name>sample string 3</Name> <NoActive>true</NoActive> <PosCode>sample string 1</PosCode> <Start>1</Start> <TemplateText>sample string 2</TemplateText> </MessageTemplatePagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
MessageTemplatePagingInfoResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRows |
Количество записей всего |
integer |
None. |
| TotalRowsSelect |
Количество записей в запросе |
integer |
None. |
| Data |
Детальные данные |
Collection of MessageTemplatePagingInfoDataRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"TotalRows": 1,
"TotalRowsSelect": 1,
"Data": [
{
"Id": 1,
"MessageTemplateId": 1,
"EvenType": 1,
"EvenTypeName": "sample string 1",
"TemplateText": "sample string 2",
"CommunicationType": 64,
"CommunicationTypeName": "sample string 3",
"Image": "sample string 4",
"Active": true,
"Title": "sample string 5",
"MobileTypeOpen": "sample string 6",
"MobileIdTypeOpen": "sample string 7",
"MessageTemplateVariable": 1,
"ProviderTemplateId": 1,
"CommunicationCodeType": 64,
"CommunicationCodeTypeName": "sample string 8",
"Name": "sample string 9"
},
{
"Id": 1,
"MessageTemplateId": 1,
"EvenType": 1,
"EvenTypeName": "sample string 1",
"TemplateText": "sample string 2",
"CommunicationType": 64,
"CommunicationTypeName": "sample string 3",
"Image": "sample string 4",
"Active": true,
"Title": "sample string 5",
"MobileTypeOpen": "sample string 6",
"MobileIdTypeOpen": "sample string 7",
"MessageTemplateVariable": 1,
"ProviderTemplateId": 1,
"CommunicationCodeType": 64,
"CommunicationCodeTypeName": "sample string 8",
"Name": "sample string 9"
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<MessageTemplatePagingInfoResponse 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>
<MessageTemplatePagingInfoResponse.MessageTemplatePagingInfoDataRow>
<Active>true</Active>
<CommunicationCodeType>64</CommunicationCodeType>
<CommunicationCodeTypeName>sample string 8</CommunicationCodeTypeName>
<CommunicationType>64</CommunicationType>
<CommunicationTypeName>sample string 3</CommunicationTypeName>
<EvenType>1</EvenType>
<EvenTypeName>sample string 1</EvenTypeName>
<Id>1</Id>
<Image>sample string 4</Image>
<MessageTemplateId>1</MessageTemplateId>
<MessageTemplateVariable>1</MessageTemplateVariable>
<MobileIdTypeOpen>sample string 7</MobileIdTypeOpen>
<MobileTypeOpen>sample string 6</MobileTypeOpen>
<Name>sample string 9</Name>
<ProviderTemplateId>1</ProviderTemplateId>
<TemplateText>sample string 2</TemplateText>
<Title>sample string 5</Title>
</MessageTemplatePagingInfoResponse.MessageTemplatePagingInfoDataRow>
<MessageTemplatePagingInfoResponse.MessageTemplatePagingInfoDataRow>
<Active>true</Active>
<CommunicationCodeType>64</CommunicationCodeType>
<CommunicationCodeTypeName>sample string 8</CommunicationCodeTypeName>
<CommunicationType>64</CommunicationType>
<CommunicationTypeName>sample string 3</CommunicationTypeName>
<EvenType>1</EvenType>
<EvenTypeName>sample string 1</EvenTypeName>
<Id>1</Id>
<Image>sample string 4</Image>
<MessageTemplateId>1</MessageTemplateId>
<MessageTemplateVariable>1</MessageTemplateVariable>
<MobileIdTypeOpen>sample string 7</MobileIdTypeOpen>
<MobileTypeOpen>sample string 6</MobileTypeOpen>
<Name>sample string 9</Name>
<ProviderTemplateId>1</ProviderTemplateId>
<TemplateText>sample string 2</TemplateText>
<Title>sample string 5</Title>
</MessageTemplatePagingInfoResponse.MessageTemplatePagingInfoDataRow>
</Data>
<TotalRows>1</TotalRows>
<TotalRowsSelect>1</TotalRowsSelect>
</MessageTemplatePagingInfoResponse>