POST api/marketing/MessageTemplateAction

Добавление, изменение, получение информации о шаблоне сообщения

Request Information

URI Parameters

None.

Body Parameters

MessageTemplateActionRequest
NameDescriptionTypeAdditional information
PosCode

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

string

None.

ActionType

Тип действия (Create, Update, Info)

string

None.

MessageTemplateId

Идентификатор шаблона, для изменения или получения информации

integer

None.

EventType

Тип евента (события) для шаблона

integer

None.

CommunicationType

Тип коммуникации в шаблоне

byte

None.

Active

Статус активности шаблона

boolean

None.

NoActive

Статус неактивности шаблона

boolean

None.

CommunicationCodeType

Идентификатор типа кода (авторизация, списание, замена карты и т.д), который отправляется по данному шаблону

byte

None.

Title

Заголовок сообщения

string

None.

MobileTypeOpen

Тип экрана моб. приложения, которое необходимо открыть при нажатии на пуш-сообщение

string

None.

MobileIdTypeOpen

Идентификатор плитки на экране моб. приложения, которую необходимо открыть при нажатии на пуш-сообщение

string

None.

ProviderTemplateId

Идентификатор шаблона сообщения во внешнем сервисе

integer

None.

TemplateText

Текст шаблона сообщения

string

None.

Image

Адрес (url) изображения в шаблоне

string

None.

MessageTemplateVariable

Идентификатор списка метапеременных, которые есть в шаблоне

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "ActionType": "sample string 2",
  "MessageTemplateId": 1,
  "EventType": 1,
  "CommunicationType": 64,
  "Active": true,
  "NoActive": true,
  "CommunicationCodeType": 64,
  "Title": "sample string 3",
  "MobileTypeOpen": "sample string 4",
  "MobileIdTypeOpen": "sample string 5",
  "ProviderTemplateId": 1,
  "TemplateText": "sample string 6",
  "Image": "sample string 7",
  "MessageTemplateVariable": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 8"
}

application/xml, text/xml

Sample:
<MessageTemplateActionRequest 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 8</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Active>true</Active>
  <CommunicationCodeType>64</CommunicationCodeType>
  <CommunicationType>64</CommunicationType>
  <EventType>1</EventType>
  <Image>sample string 7</Image>
  <MessageTemplateId>1</MessageTemplateId>
  <MessageTemplateVariable>1</MessageTemplateVariable>
  <MobileIdTypeOpen>sample string 5</MobileIdTypeOpen>
  <MobileTypeOpen>sample string 4</MobileTypeOpen>
  <NoActive>true</NoActive>
  <PosCode>sample string 1</PosCode>
  <ProviderTemplateId>1</ProviderTemplateId>
  <TemplateText>sample string 6</TemplateText>
  <Title>sample string 3</Title>
</MessageTemplateActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MessageTemplateActionResponse
NameDescriptionTypeAdditional information
MessageTemplate

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

integer

None.

Data

Детальные данные

Collection of MessageTemplateActionDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MessageTemplate": 1,
  "Data": [
    {
      "Id": 1,
      "EventType": 1,
      "Name": "sample string 1",
      "Template": "sample string 2",
      "Operator": 1,
      "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"
    },
    {
      "Id": 1,
      "EventType": 1,
      "Name": "sample string 1",
      "Template": "sample string 2",
      "Operator": 1,
      "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"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<MessageTemplateActionResponse 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>
    <MessageTemplateActionResponse.MessageTemplateActionDataRow>
      <Active>true</Active>
      <CommunicationCodeType>64</CommunicationCodeType>
      <CommunicationCodeTypeName>sample string 8</CommunicationCodeTypeName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 3</CommunicationTypeName>
      <EventType>1</EventType>
      <Id>1</Id>
      <Image>sample string 4</Image>
      <MessageTemplateVariable>1</MessageTemplateVariable>
      <MobileIdTypeOpen>sample string 7</MobileIdTypeOpen>
      <MobileTypeOpen>sample string 6</MobileTypeOpen>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <ProviderTemplateId>1</ProviderTemplateId>
      <Template>sample string 2</Template>
      <Title>sample string 5</Title>
    </MessageTemplateActionResponse.MessageTemplateActionDataRow>
    <MessageTemplateActionResponse.MessageTemplateActionDataRow>
      <Active>true</Active>
      <CommunicationCodeType>64</CommunicationCodeType>
      <CommunicationCodeTypeName>sample string 8</CommunicationCodeTypeName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 3</CommunicationTypeName>
      <EventType>1</EventType>
      <Id>1</Id>
      <Image>sample string 4</Image>
      <MessageTemplateVariable>1</MessageTemplateVariable>
      <MobileIdTypeOpen>sample string 7</MobileIdTypeOpen>
      <MobileTypeOpen>sample string 6</MobileTypeOpen>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <ProviderTemplateId>1</ProviderTemplateId>
      <Template>sample string 2</Template>
      <Title>sample string 5</Title>
    </MessageTemplateActionResponse.MessageTemplateActionDataRow>
  </Data>
  <MessageTemplate>1</MessageTemplate>
</MessageTemplateActionResponse>