POST api/bonuses/BonusMarketlistAction

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

Request Information

URI Parameters

None.

Body Parameters

BonusMarketlistActionRequest
NameDescriptionTypeAdditional information
ActionType

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

string

None.

Name

Наименование задания на начисление бонусов

string

None.

MarketList

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

integer

None.

BegDate

Дата и время старта задания (т.е. когда бонусы должны быть начислены; если не указано, то сейчас)

date

None.

Bonus

Размер бонуса, который будет начислен каждому из списка

decimal number

None.

BonusCard

Признак, что не реагируем на @bonus, и берём для каждой карты персональный бонус из маркетингового списка или списка карт/клиентов/телефонов

boolean

None.

Source

Идентификатор источника бонуса, с которым будет начисление бонусов

byte

None.

Status

Идентификатор статуса задания (1 = планируется; 2 = на модерации; 3 = готово к отправке; 7 = отменена)

byte

None.

Type

Тип задания для начисления бонусов (1 = акция сгораемые бонусы; 2 = произвольное задание)

byte

None.

BonusMarketListId

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

integer

None.

OwnerPartner

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

integer

None.

OwnerPos

Идентификатор торговой точки партнера, владельца задания

integer

None.

CardPhoneClientList

Список карт/телефонов/клиентов для создания маркетингового списка

Collection of BonusMarketlistActionCardPhoneClientListStr

None.

ActiveDate

Дата активации начисляемого бонуса

date

None.

ExpiryDate

Дата сгорания начисляемого бонуса

date

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ActionType": "sample string 1",
  "Name": "sample string 2",
  "MarketList": 1,
  "BegDate": "2024-04-25T08:17:55.4497773+03:00",
  "Bonus": 1.0,
  "BonusCard": true,
  "Source": 64,
  "Status": 64,
  "Type": 64,
  "BonusMarketListId": 1,
  "OwnerPartner": 1,
  "OwnerPos": 1,
  "CardPhoneClientList": [
    {
      "Id": 1,
      "Phone": 1,
      "Client": 1,
      "Card": 1,
      "Bonus": 1.0
    },
    {
      "Id": 1,
      "Phone": 1,
      "Client": 1,
      "Card": 1,
      "Bonus": 1.0
    }
  ],
  "ActiveDate": "2024-04-25T08:17:55.4497773+03:00",
  "ExpiryDate": "2024-04-25T08:17:55.4497773+03:00",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<BonusMarketlistActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.BonusesRequest">
  <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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 1</ActionType>
  <ActiveDate>2024-04-25T08:17:55.4497773+03:00</ActiveDate>
  <BegDate>2024-04-25T08:17:55.4497773+03:00</BegDate>
  <Bonus>1</Bonus>
  <BonusCard>true</BonusCard>
  <BonusMarketListId>1</BonusMarketListId>
  <CardPhoneClientList>
    <BonusMarketlistActionRequest.BonusMarketlistActionCardPhoneClientListStr>
      <Bonus>1</Bonus>
      <Card>1</Card>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
    </BonusMarketlistActionRequest.BonusMarketlistActionCardPhoneClientListStr>
    <BonusMarketlistActionRequest.BonusMarketlistActionCardPhoneClientListStr>
      <Bonus>1</Bonus>
      <Card>1</Card>
      <Client>1</Client>
      <Id>1</Id>
      <Phone>1</Phone>
    </BonusMarketlistActionRequest.BonusMarketlistActionCardPhoneClientListStr>
  </CardPhoneClientList>
  <ExpiryDate>2024-04-25T08:17:55.4497773+03:00</ExpiryDate>
  <MarketList>1</MarketList>
  <Name>sample string 2</Name>
  <OwnerPartner>1</OwnerPartner>
  <OwnerPos>1</OwnerPos>
  <Source>64</Source>
  <Status>64</Status>
  <Type>64</Type>
</BonusMarketlistActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BonusMarketlistActionResponse
NameDescriptionTypeAdditional information
MarketListId

Идентификатор созданного маркетингового списка, если начисление бонусов производилось через список карт/клиентов/телефонов

integer

None.

BonusMarketList

Идентификатор созданной записи о начислении бонусов

integer

None.

BonusList

Массив бонусов

Collection of BonusMarketlistActionBonusListStr

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MarketListId": 1,
  "BonusMarketList": 1,
  "BonusList": [
    {
      "Id": 1,
      "BonusMarketListId": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-04-25T08:17:55.6997793+03:00",
      "BegDate": "2024-04-25T08:17:55.6997793+03:00",
      "MarketList": 1,
      "BonusCard": true,
      "Bonus": 1.0,
      "BonusSource": 64,
      "BonusSourceName": "sample string 2",
      "Type": 64,
      "TypeName": "sample string 3",
      "Status": 64,
      "StatusName": "sample string 4",
      "ActiveDate": "2024-04-25T08:17:55.6997793+03:00",
      "ExpiryDate": "2024-04-25T08:17:55.6997793+03:00",
      "PosOwner": 1,
      "PartnerOwner": 1,
      "CountCard": 1,
      "CommunicationId": 1,
      "CommunicationName": "sample string 5",
      "MarketListName": "sample string 6"
    },
    {
      "Id": 1,
      "BonusMarketListId": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-04-25T08:17:55.6997793+03:00",
      "BegDate": "2024-04-25T08:17:55.6997793+03:00",
      "MarketList": 1,
      "BonusCard": true,
      "Bonus": 1.0,
      "BonusSource": 64,
      "BonusSourceName": "sample string 2",
      "Type": 64,
      "TypeName": "sample string 3",
      "Status": 64,
      "StatusName": "sample string 4",
      "ActiveDate": "2024-04-25T08:17:55.6997793+03:00",
      "ExpiryDate": "2024-04-25T08:17:55.6997793+03:00",
      "PosOwner": 1,
      "PartnerOwner": 1,
      "CountCard": 1,
      "CommunicationId": 1,
      "CommunicationName": "sample string 5",
      "MarketListName": "sample string 6"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<BonusMarketlistActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.BonusesResponse">
  <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>
  <BonusList>
    <BonusMarketlistActionResponse.BonusMarketlistActionBonusListStr>
      <ActiveDate>2024-04-25T08:17:55.6997793+03:00</ActiveDate>
      <BegDate>2024-04-25T08:17:55.6997793+03:00</BegDate>
      <Bonus>1</Bonus>
      <BonusCard>true</BonusCard>
      <BonusMarketListId>1</BonusMarketListId>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 2</BonusSourceName>
      <CommunicationId>1</CommunicationId>
      <CommunicationName>sample string 5</CommunicationName>
      <CountCard>1</CountCard>
      <ExpiryDate>2024-04-25T08:17:55.6997793+03:00</ExpiryDate>
      <Id>1</Id>
      <MarketList>1</MarketList>
      <MarketListName>sample string 6</MarketListName>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PartnerOwner>1</PartnerOwner>
      <PosOwner>1</PosOwner>
      <ProcTime>2024-04-25T08:17:55.6997793+03:00</ProcTime>
      <Status>64</Status>
      <StatusName>sample string 4</StatusName>
      <Type>64</Type>
      <TypeName>sample string 3</TypeName>
    </BonusMarketlistActionResponse.BonusMarketlistActionBonusListStr>
    <BonusMarketlistActionResponse.BonusMarketlistActionBonusListStr>
      <ActiveDate>2024-04-25T08:17:55.6997793+03:00</ActiveDate>
      <BegDate>2024-04-25T08:17:55.6997793+03:00</BegDate>
      <Bonus>1</Bonus>
      <BonusCard>true</BonusCard>
      <BonusMarketListId>1</BonusMarketListId>
      <BonusSource>64</BonusSource>
      <BonusSourceName>sample string 2</BonusSourceName>
      <CommunicationId>1</CommunicationId>
      <CommunicationName>sample string 5</CommunicationName>
      <CountCard>1</CountCard>
      <ExpiryDate>2024-04-25T08:17:55.6997793+03:00</ExpiryDate>
      <Id>1</Id>
      <MarketList>1</MarketList>
      <MarketListName>sample string 6</MarketListName>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PartnerOwner>1</PartnerOwner>
      <PosOwner>1</PosOwner>
      <ProcTime>2024-04-25T08:17:55.6997793+03:00</ProcTime>
      <Status>64</Status>
      <StatusName>sample string 4</StatusName>
      <Type>64</Type>
      <TypeName>sample string 3</TypeName>
    </BonusMarketlistActionResponse.BonusMarketlistActionBonusListStr>
  </BonusList>
  <BonusMarketList>1</BonusMarketList>
  <MarketListId>1</MarketListId>
</BonusMarketlistActionResponse>