POST api/questionnaire/QuestionInfo
Получение вопроса и вариантов ответов на него по идентификатору опросника
Request Information
URI Parameters
None.
Body Parameters
QuestionInfoRequestName | Description | Type | Additional information |
---|---|---|---|
ClientIShop |
Идентификатор клиента интернет-магазина (сайта) |
integer |
None. |
Client |
Идентификатор клиента в БД Mloyalty |
integer |
None. |
SourceUrl |
Урл сайт, с которого идёт запрос |
string |
None. |
SessionId |
Идентификатор сессии, которую сайт создал при заходе пользователя на сайт |
string |
None. |
Questionnaire |
Идентификатор сайта-виджета опросов для которого получаем вопросы |
integer |
None. |
Question |
Идентификатор вопроса, по которому нужно получить ответы и настройки, когда он есть |
integer |
None. |
QuestionNumber |
Номер вопроса в опросе по отношению к другим вопросам |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "ClientIShop": 1, "Client": 1, "SourceUrl": "sample string 1", "SessionId": "sample string 2", "Questionnaire": 1, "Question": 1, "QuestionNumber": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 3" }
application/xml, text/xml
<QuestionInfoRequest 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 3</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <Client>1</Client> <ClientIShop>1</ClientIShop> <Question>1</Question> <QuestionNumber>1</QuestionNumber> <Questionnaire>1</Questionnaire> <SessionId>sample string 2</SessionId> <SourceUrl>sample string 1</SourceUrl> </QuestionInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
QuestionInfoResponseName | Description | Type | Additional information |
---|---|---|---|
TextQuestion |
Текст вопроса, который нужно задать пользователю |
string |
None. |
QuestionGroupName |
Наименование группы вопросов, к которой относится вопрос |
string |
None. |
QuestionGroupId |
Идентификатор группы вопросов, к которому относится вопрос |
integer |
None. |
FreeAnswer |
Признак, что допускается свой вариант ответа |
boolean |
None. |
ManyAnswer |
Признак, что пользователь может дать более чем один ответ на вопрос |
boolean |
None. |
CommentShown |
Признак, что необходимо показать блок "оставьте комментарий" |
boolean |
None. |
CommentRequire |
Признак, что комментарий оставить обязательно |
boolean |
None. |
QuestionGroupShown |
Признак, отображать или нет наименование группы вопросов у вопроса |
boolean |
None. |
HelpForQuestionShown |
Признак, отображать или нет подсказки к вопросу |
boolean |
None. |
RelevantShown |
Признак, отображать или нет, что вопрос не актуален в контексте опроса (пользователь указывает самостоятельно) |
boolean |
None. |
LastQuestion |
Признак, что этот вопрос последний в опросе |
boolean |
None. |
Answers |
Ответы |
Collection of QuestionInfoAnswer |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TextQuestion": "sample string 1", "QuestionGroupName": "sample string 2", "QuestionGroupId": 1, "FreeAnswer": true, "ManyAnswer": true, "CommentShown": true, "CommentRequire": true, "QuestionGroupShown": true, "HelpForQuestionShown": true, "RelevantShown": true, "LastQuestion": true, "Answers": [ { "Id": 1, "Text": "sample string 1", "Image": "sample string 2" }, { "Id": 1, "Text": "sample string 1", "Image": "sample string 2" } ], "ErrorCode": 3, "Message": "sample string 4" }
application/xml, text/xml
<QuestionInfoResponse 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">3</ErrorCode> <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</Message> <Answers> <QuestionInfoResponse.QuestionInfoAnswer> <Id>1</Id> <Image>sample string 2</Image> <Text>sample string 1</Text> </QuestionInfoResponse.QuestionInfoAnswer> <QuestionInfoResponse.QuestionInfoAnswer> <Id>1</Id> <Image>sample string 2</Image> <Text>sample string 1</Text> </QuestionInfoResponse.QuestionInfoAnswer> </Answers> <CommentRequire>true</CommentRequire> <CommentShown>true</CommentShown> <FreeAnswer>true</FreeAnswer> <HelpForQuestionShown>true</HelpForQuestionShown> <LastQuestion>true</LastQuestion> <ManyAnswer>true</ManyAnswer> <QuestionGroupId>1</QuestionGroupId> <QuestionGroupName>sample string 2</QuestionGroupName> <QuestionGroupShown>true</QuestionGroupShown> <RelevantShown>true</RelevantShown> <TextQuestion>sample string 1</TextQuestion> </QuestionInfoResponse>