POST api/pos/PartnerAction
Добавление и изменение Партнера программы лояльности
Request Information
URI Parameters
None.
Body Parameters
PartnerActionRequestName | Description | Type | Additional information |
---|---|---|---|
ActionType |
Тип действия (Create, Update) |
string |
None. |
PartnerId |
Идентификатор партнера (для Update) |
integer |
None. |
Company |
Идентификатор компании, которой принадлежит партнер |
integer |
None. |
Name |
Наименование партнера |
string |
None. |
ShowOnSite |
Признак, отображать в ЛК или мобильном приложении |
boolean |
None. |
Logo |
Логотип партнера |
string |
None. |
Description |
Описание партнера |
string |
None. |
Title |
Заголовок для плитки партнера |
string |
None. |
SubTitle |
Подзаголовк для плитки партнера |
string |
None. |
MainPage |
Признак, что плитку партнера нужно отображать на гл. странице (пока не используется, историческая хрень) |
boolean |
None. |
InternetShop |
Адрес сайта/интернет-магазина партнера |
string |
None. |
InternetShopButtonName |
Наименование кнопки для адрес сайта/интернет магазина в мобильном приложении |
string |
None. |
GivesCard |
Признак, что партнер выдаёт пластиковые карты |
boolean |
None. |
Recommended |
Признак, что партнер из списка рекомендованных |
boolean |
None. |
AddressInMobile |
Признак, отображать или нет кнопку "адреса" в плитке партнера в мобильном приложении (чтобы не отображалась нужно ставить = 0) |
boolean |
None. |
ShownFranch |
Признак, отображать точки этого партнера вместе с точками того партнера чьим франчом он является |
boolean |
None. |
FrancPparent |
Идентификатор партнера, чьим франчом является добавляемый партнер |
integer |
None. |
OnePosInMobile |
Признак, что у этого партнера одна точка (это нужно для тех, кто в одном ТЦ имеет много бутиков и чтобы в мобилке отображался один адрес; также, у точки, которая там самая одна, нужно проставить такой же признак) |
boolean |
None. |
Status |
Статус партнера; ссылка на partnerstatus; пока не используется, историческая хрень |
integer |
None. |
AboutUsShown |
Партнер, который является тем, кто организовал ПЛ, чтобы в разделе "о нас" была только его плитка |
boolean |
None. |
LevelShown |
Порядковый номер плитки партнера относительно других плиток партнеров |
byte |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "ActionType": "sample string 1", "PartnerId": 1, "Company": 1, "Name": "sample string 2", "ShowOnSite": true, "Logo": "sample string 3", "Description": "sample string 4", "Title": "sample string 5", "SubTitle": "sample string 6", "MainPage": true, "InternetShop": "sample string 7", "InternetShopButtonName": "sample string 8", "GivesCard": true, "Recommended": true, "AddressInMobile": true, "ShownFranch": true, "FrancPparent": 1, "OnePosInMobile": true, "Status": 1, "AboutUsShown": true, "LevelShown": 64, "Operator": 1, "Token": 1, "SiteCode": "sample string 9" }
application/xml, text/xml
<PartnerActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request"> <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> <AboutUsShown>true</AboutUsShown> <ActionType>sample string 1</ActionType> <AddressInMobile>true</AddressInMobile> <Company>1</Company> <Description>sample string 4</Description> <FrancPparent>1</FrancPparent> <GivesCard>true</GivesCard> <InternetShop>sample string 7</InternetShop> <InternetShopButtonName>sample string 8</InternetShopButtonName> <LevelShown>64</LevelShown> <Logo>sample string 3</Logo> <MainPage>true</MainPage> <Name>sample string 2</Name> <OnePosInMobile>true</OnePosInMobile> <PartnerId>1</PartnerId> <Recommended>true</Recommended> <ShowOnSite>true</ShowOnSite> <ShownFranch>true</ShownFranch> <Status>1</Status> <SubTitle>sample string 6</SubTitle> <Title>sample string 5</Title> </PartnerActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
PartnerActionResponseName | Description | Type | Additional information |
---|---|---|---|
Partner |
Идентификатор добавленного партнера |
integer |
None. |
Data |
Массив итоговых данных |
Collection of PartnerActionDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Partner": 1, "Data": [ { "Id": 1, "Name": "sample string 1", "Logo": "sample string 2", "Description": "sample string 3", "Condition": "sample string 4", "TagLine": "sample string 5", "MainPage": true, "ShowOnSite": true, "InternetShop": "sample string 6", "GivesCard": true, "Recommended": true, "Company": 1, "Status": 64, "InternetShopButtonName": "sample string 7", "AddressInMobile": true, "ShownFranch": true, "FranchParent": 1, "OnePosInMobile": true, "AboutUsShown": true, "LevelShown": 64 }, { "Id": 1, "Name": "sample string 1", "Logo": "sample string 2", "Description": "sample string 3", "Condition": "sample string 4", "TagLine": "sample string 5", "MainPage": true, "ShowOnSite": true, "InternetShop": "sample string 6", "GivesCard": true, "Recommended": true, "Company": 1, "Status": 64, "InternetShopButtonName": "sample string 7", "AddressInMobile": true, "ShownFranch": true, "FranchParent": 1, "OnePosInMobile": true, "AboutUsShown": true, "LevelShown": 64 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<PartnerActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response"> <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> <PartnerActionResponse.PartnerActionDataRow> <AboutUsShown>true</AboutUsShown> <AddressInMobile>true</AddressInMobile> <Company>1</Company> <Condition>sample string 4</Condition> <Description>sample string 3</Description> <FranchParent>1</FranchParent> <GivesCard>true</GivesCard> <Id>1</Id> <InternetShop>sample string 6</InternetShop> <InternetShopButtonName>sample string 7</InternetShopButtonName> <LevelShown>64</LevelShown> <Logo>sample string 2</Logo> <MainPage>true</MainPage> <Name>sample string 1</Name> <OnePosInMobile>true</OnePosInMobile> <Recommended>true</Recommended> <ShowOnSite>true</ShowOnSite> <ShownFranch>true</ShownFranch> <Status>64</Status> <TagLine>sample string 5</TagLine> </PartnerActionResponse.PartnerActionDataRow> <PartnerActionResponse.PartnerActionDataRow> <AboutUsShown>true</AboutUsShown> <AddressInMobile>true</AddressInMobile> <Company>1</Company> <Condition>sample string 4</Condition> <Description>sample string 3</Description> <FranchParent>1</FranchParent> <GivesCard>true</GivesCard> <Id>1</Id> <InternetShop>sample string 6</InternetShop> <InternetShopButtonName>sample string 7</InternetShopButtonName> <LevelShown>64</LevelShown> <Logo>sample string 2</Logo> <MainPage>true</MainPage> <Name>sample string 1</Name> <OnePosInMobile>true</OnePosInMobile> <Recommended>true</Recommended> <ShowOnSite>true</ShowOnSite> <ShownFranch>true</ShownFranch> <Status>64</Status> <TagLine>sample string 5</TagLine> </PartnerActionResponse.PartnerActionDataRow> </Data> <Partner>1</Partner> </PartnerActionResponse>