POST api/questionnaire/QuestionnaireAction

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

Request Information

URI Parameters

None.

Body Parameters

QuestionnaireActionRequest
NameDescriptionTypeAdditional information
QuestionnaireName

Внутреннее наименование опроса

 string

None.
ActionType

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

 string

None.
QuestionnaireId

Идентификатор опроса, который необходимо изменить (работает только для actiontype = update)

 integer

None.
Active

Признак активации опроса (1 = активен)

 boolean

None.
NoActive

Признак деактивации опроса (1 = деактивировать); (работает только для ActionType = update)

 boolean

None.
QuestionnaireType

Идентификатор типа опроса (1 = отзыв о покупке; 2 = Кандидат в тайные покупатели; 3 = Тайный покупатель; 4 = mloyalty)

 byte

None.
Dynamic

Признак, что опрос динамический и следующий вопрос в нём будет зависеть от ответа на предыдущий вопрос

 boolean

None.
DefaultConfig

Признак, что у опроса конфиг по умолчанию

 boolean

None.
TitlePreview

Текст заголовка в плитке опроса

 string

None.
SubTitlePreview

Текст подзаголовка в плитке опроса

 string

None.
ImagePreview

Изображение в плитке опроса

 string

None.
TextPreview

Текст-описание опроса

 string

None.
UrlButtonPreview

Ссылка в кнопку "Начать опрос" для возможности отправить пользователя на внешний ресурс

 string

None.
NameButtonPreview

Наименование кнопки "Начать опрос". Если будет не указано, будет по умолчанию "Начать опрос"

 string

None.
DataShown

Признак, отображать или нет строчку "Указать данные" для прохождения опроса

 boolean

None.
PosRequire

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

 boolean

None.
ChequeRequire

Признак, обязательное ли заполнение идентификатора чека покупки/возврата при прохождении опроса

 boolean

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "QuestionnaireName": "sample string 1",
  "ActionType": "sample string 2",
  "QuestionnaireId": 1,
  "Active": true,
  "NoActive": true,
  "QuestionnaireType": 64,
  "Dynamic": true,
  "DefaultConfig": true,
  "TitlePreview": "sample string 3",
  "SubTitlePreview": "sample string 4",
  "ImagePreview": "sample string 5",
  "TextPreview": "sample string 6",
  "UrlButtonPreview": "sample string 7",
  "NameButtonPreview": "sample string 8",
  "DataShown": true,
  "PosRequire": true,
  "ChequeRequire": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 9"
}

application/xml, text/xml

Sample: 
<QuestionnaireActionRequest 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 9</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Active>true</Active>
  <ChequeRequire>true</ChequeRequire>
  <DataShown>true</DataShown>
  <DefaultConfig>true</DefaultConfig>
  <Dynamic>true</Dynamic>
  <ImagePreview>sample string 5</ImagePreview>
  <NameButtonPreview>sample string 8</NameButtonPreview>
  <NoActive>true</NoActive>
  <PosRequire>true</PosRequire>
  <QuestionnaireId>1</QuestionnaireId>
  <QuestionnaireName>sample string 1</QuestionnaireName>
  <QuestionnaireType>64</QuestionnaireType>
  <SubTitlePreview>sample string 4</SubTitlePreview>
  <TextPreview>sample string 6</TextPreview>
  <TitlePreview>sample string 3</TitlePreview>
  <UrlButtonPreview>sample string 7</UrlButtonPreview>
</QuestionnaireActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

QuestionnaireActionResponse
NameDescriptionTypeAdditional information
Questionnaire

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

 integer

None.
Data

Данные по опросу

 Collection of QuestionnaireActionData

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Questionnaire": 1,
  "Data": [
    {
      "Name": "sample string 1",
      "Active": true,
      "QuestionnaireType": 64,
      "TypeName": "sample string 2",
      "Dynamic": true,
      "SiteCode": "sample string 3",
      "DefaultConfig": true,
      "TitlePreview": "sample string 4",
      "SubTitlePreview": "sample string 5",
      "ImagePreview": "sample string 6",
      "TextPreview": "sample string 7",
      "UrlButtonPreview": "sample string 8",
      "NameButtonPreview": "sample string 9",
      "DataShown": true,
      "PosRequire": true,
      "ChequeRequire": true
    },
    {
      "Name": "sample string 1",
      "Active": true,
      "QuestionnaireType": 64,
      "TypeName": "sample string 2",
      "Dynamic": true,
      "SiteCode": "sample string 3",
      "DefaultConfig": true,
      "TitlePreview": "sample string 4",
      "SubTitlePreview": "sample string 5",
      "ImagePreview": "sample string 6",
      "TextPreview": "sample string 7",
      "UrlButtonPreview": "sample string 8",
      "NameButtonPreview": "sample string 9",
      "DataShown": true,
      "PosRequire": true,
      "ChequeRequire": true
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<QuestionnaireActionResponse 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>
    <QuestionnaireActionResponse.QuestionnaireActionData>
      <Active>true</Active>
      <ChequeRequire>true</ChequeRequire>
      <DataShown>true</DataShown>
      <DefaultConfig>true</DefaultConfig>
      <Dynamic>true</Dynamic>
      <ImagePreview>sample string 6</ImagePreview>
      <Name>sample string 1</Name>
      <NameButtonPreview>sample string 9</NameButtonPreview>
      <PosRequire>true</PosRequire>
      <QuestionnaireType>64</QuestionnaireType>
      <SiteCode>sample string 3</SiteCode>
      <SubTitlePreview>sample string 5</SubTitlePreview>
      <TextPreview>sample string 7</TextPreview>
      <TitlePreview>sample string 4</TitlePreview>
      <TypeName>sample string 2</TypeName>
      <UrlButtonPreview>sample string 8</UrlButtonPreview>
    </QuestionnaireActionResponse.QuestionnaireActionData>
    <QuestionnaireActionResponse.QuestionnaireActionData>
      <Active>true</Active>
      <ChequeRequire>true</ChequeRequire>
      <DataShown>true</DataShown>
      <DefaultConfig>true</DefaultConfig>
      <Dynamic>true</Dynamic>
      <ImagePreview>sample string 6</ImagePreview>
      <Name>sample string 1</Name>
      <NameButtonPreview>sample string 9</NameButtonPreview>
      <PosRequire>true</PosRequire>
      <QuestionnaireType>64</QuestionnaireType>
      <SiteCode>sample string 3</SiteCode>
      <SubTitlePreview>sample string 5</SubTitlePreview>
      <TextPreview>sample string 7</TextPreview>
      <TitlePreview>sample string 4</TitlePreview>
      <TypeName>sample string 2</TypeName>
      <UrlButtonPreview>sample string 8</UrlButtonPreview>
    </QuestionnaireActionResponse.QuestionnaireActionData>
  </Data>
  <Questionnaire>1</Questionnaire>
</QuestionnaireActionResponse>