POST api/marketing/SampleCreate

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

Request Information

URI Parameters

None.

Body Parameters

SampleCreateRequest
NameDescriptionTypeAdditional information
Partner

Идентификатор партнера

 integer

None.
PosCode

Код торговой точки

 string

None.
ActionType

Идентификатор типа действия: 0 = получить данные и не сохранять (по умолчанию), 1 = создать (сохранить) выборку, 2 = пересчитать

 byte

None.
MarketListCreate

Признак создания маркетингового списка (статического) из результатов выборки

 boolean

None.
MarketListForFill

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

 integer

None.
MarketListName

Наименование создаваемого маркетингового списка

 string

None.
MarketListDescription

Описание создаваемого маркетингового списка

 string

None.
SampleName

Наименование создаваемой выборки

 string

None.
SampleDescription

Описание создаваемой выборки

 string

None.
ForSms

Признак что требуется наличие номера телефона и согласие на получение смс

 boolean

None.
ForPush

Признак что требуется наличие appdevice, appregistrator и согласения на получение push

 boolean

None.
ForEmail

Признак что требуется наличие email и согласие на получение эл почты

 boolean

None.
SampleRule

Входной/выходной параметр. Если указан на входе, то берем данные из таблицы. Если был создано правило по входным параметрам, то выходной

 integer

None.
SampleData

Входной массив данных для составления выборки

 Collection of SampleCreateSampleDataStr

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Partner": 1,
  "PosCode": "sample string 1",
  "ActionType": 64,
  "MarketListCreate": true,
  "MarketListForFill": 1,
  "MarketListName": "sample string 2",
  "MarketListDescription": "sample string 3",
  "SampleName": "sample string 4",
  "SampleDescription": "sample string 5",
  "ForSms": true,
  "ForPush": true,
  "ForEmail": true,
  "SampleRule": 1,
  "SampleData": [
    {
      "Group": 1,
      "DataId": 1,
      "DataType": 1,
      "DataValueFrom": 1.0,
      "DataValueTo": 1.0,
      "Exclude": true,
      "DataBegDate": "2024-04-29T13:00:52.6149714+03:00",
      "DataEndDate": "2024-04-29T13:00:52.6149714+03:00",
      "DataTextValue": "sample string 1"
    },
    {
      "Group": 1,
      "DataId": 1,
      "DataType": 1,
      "DataValueFrom": 1.0,
      "DataValueTo": 1.0,
      "Exclude": true,
      "DataBegDate": "2024-04-29T13:00:52.6149714+03:00",
      "DataEndDate": "2024-04-29T13:00:52.6149714+03:00",
      "DataTextValue": "sample string 1"
    }
  ],
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 6"
}

application/xml, text/xml

Sample: 
<SampleCreateRequest 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 6</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>64</ActionType>
  <ForEmail>true</ForEmail>
  <ForPush>true</ForPush>
  <ForSms>true</ForSms>
  <MarketListCreate>true</MarketListCreate>
  <MarketListDescription>sample string 3</MarketListDescription>
  <MarketListForFill>1</MarketListForFill>
  <MarketListName>sample string 2</MarketListName>
  <Partner>1</Partner>
  <PosCode>sample string 1</PosCode>
  <SampleData>
    <SampleCreateRequest.SampleCreateSampleDataStr>
      <DataBegDate>2024-04-29T13:00:52.6149714+03:00</DataBegDate>
      <DataEndDate>2024-04-29T13:00:52.6149714+03:00</DataEndDate>
      <DataId>1</DataId>
      <DataTextValue>sample string 1</DataTextValue>
      <DataType>1</DataType>
      <DataValueFrom>1</DataValueFrom>
      <DataValueTo>1</DataValueTo>
      <Exclude>true</Exclude>
      <Group>1</Group>
    </SampleCreateRequest.SampleCreateSampleDataStr>
    <SampleCreateRequest.SampleCreateSampleDataStr>
      <DataBegDate>2024-04-29T13:00:52.6149714+03:00</DataBegDate>
      <DataEndDate>2024-04-29T13:00:52.6149714+03:00</DataEndDate>
      <DataId>1</DataId>
      <DataTextValue>sample string 1</DataTextValue>
      <DataType>1</DataType>
      <DataValueFrom>1</DataValueFrom>
      <DataValueTo>1</DataValueTo>
      <Exclude>true</Exclude>
      <Group>1</Group>
    </SampleCreateRequest.SampleCreateSampleDataStr>
  </SampleData>
  <SampleDescription>sample string 5</SampleDescription>
  <SampleName>sample string 4</SampleName>
  <SampleRule>1</SampleRule>
</SampleCreateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SampleCreateResponse
NameDescriptionTypeAdditional information
SampleRule

Входной/выходной параметр. Если указан на входе, то берем данные из таблицы. Если был создано правило по входным параметрам, то выходной

 integer

None.
CreatedMarketList

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

 integer

None.
AllowSms

Количество участников в выборке у которых есть номер телефона и согласие на получение смс

 integer

None.
AllowEmail

Количество участников в выборке у которых есть адрес эл почты и согласие на получение эл почты

 integer

None.
AllowPush

Количество участников в выборке у которых есть appdevice, appregistator и согласие на получаение пуш-уведомлений

 integer

None.
Total

Общее количество карт попавшее в выборку

 integer

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "SampleRule": 1,
  "CreatedMarketList": 1,
  "AllowSms": 1,
  "AllowEmail": 1,
  "AllowPush": 1,
  "Total": 1,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<SampleCreateResponse 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>
  <AllowEmail>1</AllowEmail>
  <AllowPush>1</AllowPush>
  <AllowSms>1</AllowSms>
  <CreatedMarketList>1</CreatedMarketList>
  <SampleRule>1</SampleRule>
  <Total>1</Total>
</SampleCreateResponse>