POST api/questionnaire/ShownRuleAction

Добавление нового, изменение существующего или получение информации по правилу отображения опроса, на основании идентификатора опроса

Request Information

URI Parameters

None.

Body Parameters

ShownRuleActionRequest
NameDescriptionTypeAdditional information
ActionType

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

string

None.

Active

Признак активации правила

boolean

None.

NoActive

Признак деактивации правила

boolean

None.

BegDate

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

date

None.

EndDate

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

date

None.

Questionnaire

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

integer

None.

CountWorks

Количество раз, которое опрос в принципе, может отобржаться клиенту

byte

None.

DaysAgainShown

Количество дней после прохождения опроса, через которое опрос снова может отображаться клиенту

integer

None.

CardType

Тип карты, которым отображается опрос

integer

None.

CardTypeList

Список типов карт, которым отображается опрос

integer

None.

NoCardType

Тип карты, которым не отображается опрос

integer

None.

NoCardTypeList

Список типов карт, которым не отображается опрос

integer

None.

MarketList

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

integer

None.

ClientList

Список клиентов, которым отображается опрос

integer

None.

PersonList

Список пользователей, которым отображается опрос

integer

None.

QuestionnaireShownType

Тип отображения опроса (1 = отображение происходит после события)

byte

None.

RuleId

Идентификатор правила (только для Update или Info)

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ActionType": "sample string 1",
  "Active": true,
  "NoActive": true,
  "BegDate": "2023-03-29T00:20:41.2129534+03:00",
  "EndDate": "2023-03-29T00:20:41.2129534+03:00",
  "Questionnaire": 1,
  "CountWorks": 64,
  "DaysAgainShown": 1,
  "CardType": 1,
  "CardTypeList": 1,
  "NoCardType": 1,
  "NoCardTypeList": 1,
  "MarketList": 1,
  "ClientList": 1,
  "PersonList": 1,
  "QuestionnaireShownType": 64,
  "RuleId": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<ShownRuleActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.QuestionnaireRequest">
  <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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 1</ActionType>
  <Active>true</Active>
  <BegDate>2023-03-29T00:20:41.2129534+03:00</BegDate>
  <CardType>1</CardType>
  <CardTypeList>1</CardTypeList>
  <ClientList>1</ClientList>
  <CountWorks>64</CountWorks>
  <DaysAgainShown>1</DaysAgainShown>
  <EndDate>2023-03-29T00:20:41.2129534+03:00</EndDate>
  <MarketList>1</MarketList>
  <NoActive>true</NoActive>
  <NoCardType>1</NoCardType>
  <NoCardTypeList>1</NoCardTypeList>
  <PersonList>1</PersonList>
  <Questionnaire>1</Questionnaire>
  <QuestionnaireShownType>64</QuestionnaireShownType>
  <RuleId>1</RuleId>
</ShownRuleActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShownRuleActionResponse
NameDescriptionTypeAdditional information
Rule

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

integer

None.

Data

Данные по правилам

Collection of ShownRuleActionData

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Rule": 1,
  "Data": [
    {
      "Operator": 1,
      "Questionnaire": 1,
      "BegDate": "2023-03-29T00:20:41.2285776+03:00",
      "EndDate": "2023-03-29T00:20:41.2285776+03:00",
      "Active": true,
      "CountWorks": 64,
      "DaysAgainShown": 1,
      "CardType": 1,
      "NoCardType": 1,
      "CardTypeList": 1,
      "NoCardTypeList": 1,
      "MarketList": 1,
      "MarketListName": "sample string 1",
      "ClientList": 1,
      "PersonList": 1,
      "QuestionnaireShownType": 64,
      "QuestionnaireShownTypeName": "sample string 2"
    },
    {
      "Operator": 1,
      "Questionnaire": 1,
      "BegDate": "2023-03-29T00:20:41.2285776+03:00",
      "EndDate": "2023-03-29T00:20:41.2285776+03:00",
      "Active": true,
      "CountWorks": 64,
      "DaysAgainShown": 1,
      "CardType": 1,
      "NoCardType": 1,
      "CardTypeList": 1,
      "NoCardTypeList": 1,
      "MarketList": 1,
      "MarketListName": "sample string 1",
      "ClientList": 1,
      "PersonList": 1,
      "QuestionnaireShownType": 64,
      "QuestionnaireShownTypeName": "sample string 2"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ShownRuleActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.QuestionnaireResponse">
  <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>
    <ShownRuleActionResponse.ShownRuleActionData>
      <Active>true</Active>
      <BegDate>2023-03-29T00:20:41.2285776+03:00</BegDate>
      <CardType>1</CardType>
      <CardTypeList>1</CardTypeList>
      <ClientList>1</ClientList>
      <CountWorks>64</CountWorks>
      <DaysAgainShown>1</DaysAgainShown>
      <EndDate>2023-03-29T00:20:41.2285776+03:00</EndDate>
      <MarketList>1</MarketList>
      <MarketListName>sample string 1</MarketListName>
      <NoCardType>1</NoCardType>
      <NoCardTypeList>1</NoCardTypeList>
      <Operator>1</Operator>
      <PersonList>1</PersonList>
      <Questionnaire>1</Questionnaire>
      <QuestionnaireShownType>64</QuestionnaireShownType>
      <QuestionnaireShownTypeName>sample string 2</QuestionnaireShownTypeName>
    </ShownRuleActionResponse.ShownRuleActionData>
    <ShownRuleActionResponse.ShownRuleActionData>
      <Active>true</Active>
      <BegDate>2023-03-29T00:20:41.2285776+03:00</BegDate>
      <CardType>1</CardType>
      <CardTypeList>1</CardTypeList>
      <ClientList>1</ClientList>
      <CountWorks>64</CountWorks>
      <DaysAgainShown>1</DaysAgainShown>
      <EndDate>2023-03-29T00:20:41.2285776+03:00</EndDate>
      <MarketList>1</MarketList>
      <MarketListName>sample string 1</MarketListName>
      <NoCardType>1</NoCardType>
      <NoCardTypeList>1</NoCardTypeList>
      <Operator>1</Operator>
      <PersonList>1</PersonList>
      <Questionnaire>1</Questionnaire>
      <QuestionnaireShownType>64</QuestionnaireShownType>
      <QuestionnaireShownTypeName>sample string 2</QuestionnaireShownTypeName>
    </ShownRuleActionResponse.ShownRuleActionData>
  </Data>
  <Rule>1</Rule>
</ShownRuleActionResponse>