POST api/marketing/CampaignAction

Создание / изменение / получение информации о кампании

Request Information

URI Parameters

None.

Body Parameters

CampaignActionRequest
NameDescriptionTypeAdditional information
CampaignType

Идентификатор типа акции (1 = Акция, 2 = Оффер)

 byte

None.
Name

Наименование

 string

None.
ActionType

Тип действия, которое необходимо произвести (Create, Update, Info)

 string

None.
Active

Признак активации кампании (для Update)

 boolean

None.
NoActive

Признак деактивации кампании (для Update)

 boolean

None.
StartDate

Дата начала действия

 date

None.
EndDate

Дата окончания действия

 date

None.
Description

Описание

 string

None.
Logo

Ссылка на изображение

 string

None.
BigLogo

Ссылка на большое изображение

 string

None.
Title

Заголовок

 string

None.
SubTitle

Подзаголовок

 string

None.
MarketList

Маркетиновый список, которому отображается акция как доступная

 integer

None.
Partner

Партнер, у которого действует акция

 integer

None.
Pos

Точка продаж, в которой действует акция

 integer

None.
PosList

Список точек продаж, в которых действует акция

 integer

None.
NoPoses

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

 boolean

None.
New

Признак, что эта акция "новинка" (для тегов и фильтрации)

 boolean

None.
Recommended

Признак, что эта акция "рекомендуемая" (для тегов и фильтрации)

 boolean

None.
MainPage

Признак, что эту акцию нужно отобразить на гл. странице сайта/гл. экране моб. приложения

 boolean

None.
OfferType

Тип оффера по акции (1 = промокод, 2 = промоссылка)

 byte

None.
OfferUrl

Ссылка, по которой будет доступен оффер (пользователь должен по этой ссылке перейти)

 string

None.
Price

Цена оффера по акции

 decimal number

None.
OldPrice

Старая цена оффера по акции

 decimal number

None.
ExpireDaysBefore

За сколько дней до окончания срока действия оффера по акции отображать признак "сгорающая акция"

 byte

None.
CampaignId

Идентификатор кампании для изменения или получения информации (для Update)

 integer

None.
RegPosList

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

 integer

None.
NoRegPosList

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

 integer

None.
PurchasePosList

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

 integer

None.
NoPurchasePosList

Идентификатор списка точек продаж, в которых была хотя бы одна покупка клиента, которому НЕ нужно отображать акцию

 integer

None.
LevelShown

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

 byte

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CampaignType": 64,
  "Name": "sample string 1",
  "ActionType": "sample string 2",
  "Active": true,
  "NoActive": true,
  "StartDate": "2024-04-29T17:20:14.9448214+03:00",
  "EndDate": "2024-04-29T17:20:14.9448214+03:00",
  "Description": "sample string 3",
  "Logo": "sample string 4",
  "BigLogo": "sample string 5",
  "Title": "sample string 6",
  "SubTitle": "sample string 7",
  "MarketList": 1,
  "Partner": 1,
  "Pos": 1,
  "PosList": 1,
  "NoPoses": true,
  "New": true,
  "Recommended": true,
  "MainPage": true,
  "OfferType": 64,
  "OfferUrl": "sample string 8",
  "Price": 1.0,
  "OldPrice": 1.0,
  "ExpireDaysBefore": 64,
  "CampaignId": 1,
  "RegPosList": 1,
  "NoRegPosList": 1,
  "PurchasePosList": 1,
  "NoPurchasePosList": 1,
  "LevelShown": 64,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 9"
}

application/xml, text/xml

Sample: 
<CampaignActionRequest 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 9</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Active>true</Active>
  <BigLogo>sample string 5</BigLogo>
  <CampaignId>1</CampaignId>
  <CampaignType>64</CampaignType>
  <Description>sample string 3</Description>
  <EndDate>2024-04-29T17:20:14.9448214+03:00</EndDate>
  <ExpireDaysBefore>64</ExpireDaysBefore>
  <LevelShown>64</LevelShown>
  <Logo>sample string 4</Logo>
  <MainPage>true</MainPage>
  <MarketList>1</MarketList>
  <Name>sample string 1</Name>
  <New>true</New>
  <NoActive>true</NoActive>
  <NoPoses>true</NoPoses>
  <NoPurchasePosList>1</NoPurchasePosList>
  <NoRegPosList>1</NoRegPosList>
  <OfferType>64</OfferType>
  <OfferUrl>sample string 8</OfferUrl>
  <OldPrice>1</OldPrice>
  <Partner>1</Partner>
  <Pos>1</Pos>
  <PosList>1</PosList>
  <Price>1</Price>
  <PurchasePosList>1</PurchasePosList>
  <Recommended>true</Recommended>
  <RegPosList>1</RegPosList>
  <StartDate>2024-04-29T17:20:14.9448214+03:00</StartDate>
  <SubTitle>sample string 7</SubTitle>
  <Title>sample string 6</Title>
</CampaignActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CampaignActionResponse
NameDescriptionTypeAdditional information
Campaign

Идентификатор созданной кампании

 integer

None.
Data

Данные

 Collection of CampaignActionData

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Campaign": 1,
  "Data": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "Active": true,
      "StartDate": "2024-04-29T17:20:14.9916938+03:00",
      "EndDate": "2024-04-29T17:20:14.9916938+03:00",
      "Description": "sample string 2",
      "Logo": "sample string 3",
      "BigLogo": "sample string 4",
      "TagLine": "sample string 5",
      "Condition": "sample string 6",
      "CampaignType": 64,
      "CampaignTypeName": "sample string 7",
      "MarketList": 1,
      "MarketListName": "sample string 8",
      "Partner": 1,
      "PartnerName": "sample string 9",
      "Pos": 1,
      "PosName": "sample string 10",
      "PosList": 1,
      "Caption": "sample string 11",
      "NoPoses": true,
      "New": true,
      "Recommended": true,
      "MainPage": true,
      "OfferType": 64,
      "OfferUrl": "sample string 12",
      "Price": 1.0,
      "OldPrice": 1.0,
      "ExpireDaysBefore": 64,
      "RegPosList": 1,
      "NoRegPosList": 1,
      "PurchasePosList": 1,
      "NoPurchasePosList": 1,
      "RegPosListName": "sample string 13",
      "NoRegPosListName": "sample string 14",
      "PurchasePosListName": "sample string 15",
      "NoPurchasePosListName": "sample string 16",
      "LevelShown": 64
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "Active": true,
      "StartDate": "2024-04-29T17:20:14.9916938+03:00",
      "EndDate": "2024-04-29T17:20:14.9916938+03:00",
      "Description": "sample string 2",
      "Logo": "sample string 3",
      "BigLogo": "sample string 4",
      "TagLine": "sample string 5",
      "Condition": "sample string 6",
      "CampaignType": 64,
      "CampaignTypeName": "sample string 7",
      "MarketList": 1,
      "MarketListName": "sample string 8",
      "Partner": 1,
      "PartnerName": "sample string 9",
      "Pos": 1,
      "PosName": "sample string 10",
      "PosList": 1,
      "Caption": "sample string 11",
      "NoPoses": true,
      "New": true,
      "Recommended": true,
      "MainPage": true,
      "OfferType": 64,
      "OfferUrl": "sample string 12",
      "Price": 1.0,
      "OldPrice": 1.0,
      "ExpireDaysBefore": 64,
      "RegPosList": 1,
      "NoRegPosList": 1,
      "PurchasePosList": 1,
      "NoPurchasePosList": 1,
      "RegPosListName": "sample string 13",
      "NoRegPosListName": "sample string 14",
      "PurchasePosListName": "sample string 15",
      "NoPurchasePosListName": "sample string 16",
      "LevelShown": 64
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<CampaignActionResponse 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>
  <Campaign>1</Campaign>
  <Data>
    <CampaignActionResponse.CampaignActionData>
      <Active>true</Active>
      <BigLogo>sample string 4</BigLogo>
      <CampaignType>64</CampaignType>
      <CampaignTypeName>sample string 7</CampaignTypeName>
      <Caption>sample string 11</Caption>
      <Condition>sample string 6</Condition>
      <Description>sample string 2</Description>
      <EndDate>2024-04-29T17:20:14.9916938+03:00</EndDate>
      <ExpireDaysBefore>64</ExpireDaysBefore>
      <Id>1</Id>
      <LevelShown>64</LevelShown>
      <Logo>sample string 3</Logo>
      <MainPage>true</MainPage>
      <MarketList>1</MarketList>
      <MarketListName>sample string 8</MarketListName>
      <Name>sample string 1</Name>
      <New>true</New>
      <NoPoses>true</NoPoses>
      <NoPurchasePosList>1</NoPurchasePosList>
      <NoPurchasePosListName>sample string 16</NoPurchasePosListName>
      <NoRegPosList>1</NoRegPosList>
      <NoRegPosListName>sample string 14</NoRegPosListName>
      <OfferType>64</OfferType>
      <OfferUrl>sample string 12</OfferUrl>
      <OldPrice>1</OldPrice>
      <Partner>1</Partner>
      <PartnerName>sample string 9</PartnerName>
      <Pos>1</Pos>
      <PosList>1</PosList>
      <PosName>sample string 10</PosName>
      <Price>1</Price>
      <PurchasePosList>1</PurchasePosList>
      <PurchasePosListName>sample string 15</PurchasePosListName>
      <Recommended>true</Recommended>
      <RegPosList>1</RegPosList>
      <RegPosListName>sample string 13</RegPosListName>
      <StartDate>2024-04-29T17:20:14.9916938+03:00</StartDate>
      <TagLine>sample string 5</TagLine>
    </CampaignActionResponse.CampaignActionData>
    <CampaignActionResponse.CampaignActionData>
      <Active>true</Active>
      <BigLogo>sample string 4</BigLogo>
      <CampaignType>64</CampaignType>
      <CampaignTypeName>sample string 7</CampaignTypeName>
      <Caption>sample string 11</Caption>
      <Condition>sample string 6</Condition>
      <Description>sample string 2</Description>
      <EndDate>2024-04-29T17:20:14.9916938+03:00</EndDate>
      <ExpireDaysBefore>64</ExpireDaysBefore>
      <Id>1</Id>
      <LevelShown>64</LevelShown>
      <Logo>sample string 3</Logo>
      <MainPage>true</MainPage>
      <MarketList>1</MarketList>
      <MarketListName>sample string 8</MarketListName>
      <Name>sample string 1</Name>
      <New>true</New>
      <NoPoses>true</NoPoses>
      <NoPurchasePosList>1</NoPurchasePosList>
      <NoPurchasePosListName>sample string 16</NoPurchasePosListName>
      <NoRegPosList>1</NoRegPosList>
      <NoRegPosListName>sample string 14</NoRegPosListName>
      <OfferType>64</OfferType>
      <OfferUrl>sample string 12</OfferUrl>
      <OldPrice>1</OldPrice>
      <Partner>1</Partner>
      <PartnerName>sample string 9</PartnerName>
      <Pos>1</Pos>
      <PosList>1</PosList>
      <PosName>sample string 10</PosName>
      <Price>1</Price>
      <PurchasePosList>1</PurchasePosList>
      <PurchasePosListName>sample string 15</PurchasePosListName>
      <Recommended>true</Recommended>
      <RegPosList>1</RegPosList>
      <RegPosListName>sample string 13</RegPosListName>
      <StartDate>2024-04-29T17:20:14.9916938+03:00</StartDate>
      <TagLine>sample string 5</TagLine>
    </CampaignActionResponse.CampaignActionData>
  </Data>
</CampaignActionResponse>