POST api/site/LoyaltyVidgetConfig
Получение настроек виджета системы лояльности
Request Information
URI Parameters
None.
Body Parameters
LoyaltyVidgetConfigRequestName | Description | Type | Additional information |
---|---|---|---|
Client |
Идентификатор клиента |
integer |
None. |
SourceUrl |
Адрес сайта, с которого запрашивается конфиг виджета |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Client": 1, "SourceUrl": "sample string 1", "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
Sample:
<LoyaltyVidgetConfigRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models"> <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> <Client>1</Client> <SourceUrl>sample string 1</SourceUrl> </LoyaltyVidgetConfigRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LoyaltyVidgetConfigResponseName | Description | Type | Additional information |
---|---|---|---|
SessionId |
Идентфикатор сессии сайта |
string |
None. |
Theme |
Тема сайта |
string |
None. |
Animation |
Тип анимации |
string |
None. |
Style |
Стиль сайта |
LoyaltyVidgetConfigStyle |
None. |
RequestData |
Параметры для дальнейших запросов в API |
LoyaltyVidgetConfigRequestData |
None. |
VidgetOwner |
Контакты владельца виджета |
LoyaltyVidgetConfigVidgetOwner |
None. |
Rules |
Правила программы |
LoyaltyVidgetConfigRules |
None. |
Pages |
Массив страниц виджета |
Collection of LoyaltyVidgetConfigPages |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "SessionId": "sample string 1", "Theme": "sample string 2", "Animation": "sample string 3", "Style": { "Font": "sample string 1", "BackgroundColor": "sample string 2", "ButtonColor": "sample string 3", "IconActiveColor": "sample string 4", "OutlineActiveColor": "sample string 5" }, "RequestData": { "Operator": 1, "Partner": 1, "PosCode": "sample string 1", "Token": 1 }, "VidgetOwner": { "Phone": "sample string 1", "Site": "sample string 2", "Logo": "sample string 3" }, "Rules": { "Url": "sample string 1", "Text": "sample string 2" }, "Pages": [ { "Name": "sample string 1", "Type": "sample string 2", "MainPage": true }, { "Name": "sample string 1", "Type": "sample string 2", "MainPage": true } ], "ErrorCode": 4, "Message": "sample string 5" }
application/xml, text/xml
Sample:
<LoyaltyVidgetConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models"> <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">4</ErrorCode> <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 5</Message> <Animation>sample string 3</Animation> <Pages> <LoyaltyVidgetConfigResponse.LoyaltyVidgetConfigPages> <MainPage>true</MainPage> <Name>sample string 1</Name> <Type>sample string 2</Type> </LoyaltyVidgetConfigResponse.LoyaltyVidgetConfigPages> <LoyaltyVidgetConfigResponse.LoyaltyVidgetConfigPages> <MainPage>true</MainPage> <Name>sample string 1</Name> <Type>sample string 2</Type> </LoyaltyVidgetConfigResponse.LoyaltyVidgetConfigPages> </Pages> <RequestData> <Operator>1</Operator> <Partner>1</Partner> <PosCode>sample string 1</PosCode> <Token>1</Token> </RequestData> <Rules> <Text>sample string 2</Text> <Url>sample string 1</Url> </Rules> <SessionId>sample string 1</SessionId> <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 2</Theme> <VidgetOwner> <Logo>sample string 3</Logo> <Phone>sample string 1</Phone> <Site>sample string 2</Site> </VidgetOwner> </LoyaltyVidgetConfigResponse>