POST api/questionnaire/SiteConfig
Получение настроек сайта-виджета опросов
Request Information
URI Parameters
None.
Body Parameters
QuestionnaireRequestName | Description | Type | Additional information |
---|---|---|---|
SourceUrl |
Адрес сайта, с которого запрашивается конфиг виджета |
string |
None. |
ClientIShop |
Идентификатор клиента интернет-магазина (сайта) |
integer |
None. |
SessionId |
Идентификатор сессии, которую сайт создал при заходе пользователя на сайт |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SourceUrl": "sample string 1", "ClientIShop": 1, "SessionId": "sample string 2", "Operator": 1, "Token": 1, "SiteCode": "sample string 3" }
application/xml, text/xml
Sample:
<SiteConfigRequest 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> <ClientIShop>1</ClientIShop> <SessionId>sample string 2</SessionId> <SourceUrl>sample string 1</SourceUrl> </SiteConfigRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
QuestionnaireResponseName | Description | Type | Additional information |
---|---|---|---|
Questionnaire |
Идентификатор опроса, для которого нужно построить сайт-виджет |
integer |
None. |
Theme |
Тема сайта |
string |
None. |
Animation |
Тип анимации |
string |
None. |
Dynamic |
Тип анимации |
boolean |
None. |
Style |
Стиль сайта |
SiteConfigStyle |
None. |
QuestionnairePageConfigList |
Стиль сайта |
Collection of SiteConfigQuestionnairePageConfigList |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Questionnaire": 1, "Theme": "sample string 1", "Animation": "sample string 2", "Dynamic": true, "Style": { "Font": "sample string 1", "BackgroundColor": "sample string 2", "ButtonColor": "sample string 3", "IconActiveColor": "sample string 4", "OutlineActiveColor": "sample string 5" }, "QuestionnairePageConfigList": [ { "Id": 1, "PageName": "sample string 1", "PageId": 64, "LevelStep": 64, "PageConfig": { "Title": "sample string 1", "SubTitle": "sample string 2", "Text": "sample string 3", "ImageMain": "sample string 4", "PhoneShown": true, "PhoneRequire": true, "NameShown": true, "NameRequire": true, "EmailShown": true, "EmailRequire": true, "DownloadShown": true, "UrlDownload": "sample string 5", "LoadShown": true, "UrlRedirect": "sample string 6", "UrlAgreement": "sample string 7", "TextAgreement": "sample string 8" } }, { "Id": 1, "PageName": "sample string 1", "PageId": 64, "LevelStep": 64, "PageConfig": { "Title": "sample string 1", "SubTitle": "sample string 2", "Text": "sample string 3", "ImageMain": "sample string 4", "PhoneShown": true, "PhoneRequire": true, "NameShown": true, "NameRequire": true, "EmailShown": true, "EmailRequire": true, "DownloadShown": true, "UrlDownload": "sample string 5", "LoadShown": true, "UrlRedirect": "sample string 6", "UrlAgreement": "sample string 7", "TextAgreement": "sample string 8" } } ], "ErrorCode": 3, "Message": "sample string 4" }
application/xml, text/xml
Sample:
<SiteConfigResponse 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> <Animation>sample string 2</Animation> <Dynamic>true</Dynamic> <Questionnaire>1</Questionnaire> <QuestionnairePageConfigList> <SiteConfigResponse.SiteConfigQuestionnairePageConfigList> <Id>1</Id> <LevelStep>64</LevelStep> <PageConfig> <DownloadShown>true</DownloadShown> <EmailRequire>true</EmailRequire> <EmailShown>true</EmailShown> <ImageMain>sample string 4</ImageMain> <LoadShown>true</LoadShown> <NameRequire>true</NameRequire> <NameShown>true</NameShown> <PhoneRequire>true</PhoneRequire> <PhoneShown>true</PhoneShown> <SubTitle>sample string 2</SubTitle> <Text>sample string 3</Text> <TextAgreement>sample string 8</TextAgreement> <Title>sample string 1</Title> <UrlAgreement>sample string 7</UrlAgreement> <UrlDownload>sample string 5</UrlDownload> <UrlRedirect>sample string 6</UrlRedirect> </PageConfig> <PageId>64</PageId> <PageName>sample string 1</PageName> </SiteConfigResponse.SiteConfigQuestionnairePageConfigList> <SiteConfigResponse.SiteConfigQuestionnairePageConfigList> <Id>1</Id> <LevelStep>64</LevelStep> <PageConfig> <DownloadShown>true</DownloadShown> <EmailRequire>true</EmailRequire> <EmailShown>true</EmailShown> <ImageMain>sample string 4</ImageMain> <LoadShown>true</LoadShown> <NameRequire>true</NameRequire> <NameShown>true</NameShown> <PhoneRequire>true</PhoneRequire> <PhoneShown>true</PhoneShown> <SubTitle>sample string 2</SubTitle> <Text>sample string 3</Text> <TextAgreement>sample string 8</TextAgreement> <Title>sample string 1</Title> <UrlAgreement>sample string 7</UrlAgreement> <UrlDownload>sample string 5</UrlDownload> <UrlRedirect>sample string 6</UrlRedirect> </PageConfig> <PageId>64</PageId> <PageName>sample string 1</PageName> </SiteConfigResponse.SiteConfigQuestionnairePageConfigList> </QuestionnairePageConfigList> <Style> <BackgroundColor>sample string 2</BackgroundColor> <ButtonColor>sample string 3</ButtonColor> <Font>sample string 1</Font> <IconActiveColor>sample string 4</IconActiveColor> <OutlineActiveColor>sample string 5</OutlineActiveColor> </Style> <Theme>sample string 1</Theme> </SiteConfigResponse>