POST api/mobile/MobileOperatorAction
Создание мобильного оператора
Request Information
URI Parameters
None.
Body Parameters
MobileOperatorCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ActionType |
Тип действия (Create, Update) |
string |
None. |
| Phone |
номер телефона оператора |
string |
None. |
| LogUrl |
url логотипа, который на экране авторизации |
string |
None. |
| AgreementUrl |
url правил программы (политики конфиденциальности), который на экране авторизации |
string |
None. |
| PartnerScreenName |
наименование пункта меню "Партнеры" |
string |
None. |
| ShareBonusName |
наименование раздела под блоком "Всего бонусов", в разделе "Мои бонусы" |
string |
None. |
| ShareBonusUrl |
url внешнего ресурса, на который необходимо перенаправить пользователя |
string |
None. |
| ShareBonusScreen |
идентификатор экрана, на который нужно перенаправить пользователя |
string |
None. |
| ChildrenScreen |
отображать наименование и блок "Дети" в разделе Настройки |
boolean |
None. |
| ShareMobile |
отображать или нет ссылку и блок "Пригласить друга" |
boolean |
None. |
| ShareMobileMessage |
сообщение для репоста в кнопке "Пригласить друга" |
string |
None. |
| ShareMobileUrl |
ссылка в сообщении для репоста "Пригласить друга" |
string |
None. |
| HistoryDetail |
отображать наименование и блок "Детализация" в плитке чеков |
boolean |
None. |
| HistoryFeedback |
отображать наименование и блок "Оставить отзыв" в плитке чеков |
boolean |
None. |
| HistoryFeedbackColor |
цвет текста "Оставить отзыв" в плитке чек, в на экране "история бонусов" |
string |
None. |
| ClientFeedbackColor |
фон сообщений ОТ клиента в разделе "обратная связь" |
string |
None. |
| BackgroundColor |
основной цвет приложения (фон, элементы, , бургеры, плюсики, подсветка пунктов меню, надписи и т.д.) |
string |
None. |
| ButtonColor |
цвет кнопок в приложении |
string |
None. |
| BonusAddColor |
цвет цифр начисленных бонусов |
string |
None. |
| BonusRedeemColor |
цвет цифр списанных и сгоревших бонусов |
string |
None. |
| QuestionnaireShown |
отображать или нет пункт меню "Опросы" |
boolean |
None. |
| GoodsCatalogId |
идентификатор товарного каталога оператора |
integer |
None. |
| CampaignSubtitleShown |
отображать или нет подзаголовок в плитках и карточках акций |
boolean |
None. |
| CampaignTitleShown |
отображать или нет заголовок в плитках и карточках акций |
boolean |
None. |
| CampaignDetailShown |
отображать или нет заголовок в плитках и карточках акций |
boolean |
None. |
| CampaignNumberShown |
отображать или нет текст с идентификатором акции |
boolean |
None. |
| ClientFeedbackColorTitle |
цвет заголовка в компоненте "вопрос или ответ" в разделе обратная связь |
string |
None. |
| ClientFeedbackColorSystem |
цвет текста номера обращения и времени обращения в компоненте "вопрос или ответ" в разделе обратная связь |
string |
None. |
| ClientFeedbackColorText |
цвет текста-ответа в компоненте "вопрос или ответ" в разделе обратная связь |
string |
None. |
| AllowEmailOnlineChequeShown |
признак, отображать или нет разрешение на отправку на email онлайн чеков |
boolean |
None. |
| VersionMobile |
актуальная версия мобильного приложения (работает, если на входе задан appregistrator) |
string |
None. |
| MarketUrl |
ссылка для скачивания моб. приложения (работает, если на входе задан appregistrator) |
string |
None. |
| LevelsModalShown |
отображать или нет иконку, которая вызывает модальное окно детализации уровней клиента |
boolean |
None. |
| LevelsModalType |
тип модального окна, котораое отображается при нажатии на иконку |
string |
None. |
| CardLevelsDetailShown |
отображать или нет экран детализации статистики по карте, включая уровни |
boolean |
None. |
| CardLevelsDetailType |
тип экрана детализации статистики по карте, включая уровни |
string |
None. |
| SearchGoodShown |
отображать или нет иконку поиска товара по qr-коду или штрих-коду в верхней плашке |
boolean |
None. |
| SearchGoodType |
тип идентификатора поиска: 1 = qr-код, 2 = штрих-код |
string |
None. |
| SearchGoodsNameShown |
отображать или нет иконку поиска товаров по наименованию в верхней плашке |
boolean |
None. |
| CallbackShown |
отображать или нет иконку обратного звонка в верхней плашке |
boolean |
None. |
| PriceListUrl |
ссылка на прайслист оператора; если указана, в разделе "Ещё" в мобильном приложении появляется раздел "Прайс-лист" |
string |
None. |
| BottomMenuFixed |
признак, что нижнее меню фиксированное и видно на всех экранах |
boolean |
None. |
| BasketContragentDepends |
признак, нужно ли учитывать зависимость контрагента и корзины при добавлении пользователем товара в корзину |
boolean |
None. |
| CardMergeShown |
признак, нужно ли отображать пункт меню "Заменить карту" и весь функционал, связанный с ним |
boolean |
None. |
| CardMergeName |
наименование пункта меню "Заменить карту" |
string |
None. |
| SetFriendPhoneShown |
признак, нужно ли отображать пункт меню "Телефон друга" |
boolean |
None. |
| SetFriendPhoneType |
тип модалки "Приведи друга", которую нужно отобразить |
string |
None. |
| UrlServiceVidget |
урл, по которому нужно открыть сайт-виджет |
string |
None. |
| PageForCloseServiceVidget |
наименование страницы сайта, при открытии которой приложение должно закрыть виджет услуг |
string |
None. |
| FullFormRegistration |
признак отображения полной формы регистрации клиента в приложении |
boolean |
None. |
| UrlPersonalData |
урл, по которому размещен документ согласия на обработку персональных данных |
string |
None. |
| CouponShown |
признак, нужно ли отображать пункт меню "Считать купон" |
boolean |
None. |
| CouponShownType |
типа ввода/считывания промокода/купона (1 = считываем камерой qr-код) |
byte |
None. |
| CouponShownName |
наименование пункта меню "Считать купон" |
string |
None. |
| CustomPushModalShown |
признак, показывать или нет кастомное модальное окно с предложением включить пуш-уведомления |
boolean |
None. |
| CustomPushModalTitle |
заголовок в модальном окне с предложением включить пуш-уведомления |
string |
None. |
| CustomPushModalText |
текст в модальном окне с предложением включить пуш-уведомления |
string |
None. |
| WithConfig |
признак, что у приложения есть конфиг (т.е. новая версия приложения используется) |
boolean |
None. |
| ScreenConfigId |
идентификатор конфига приложения |
integer |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"ActionType": "sample string 1",
"Phone": "sample string 2",
"LogUrl": "sample string 3",
"AgreementUrl": "sample string 4",
"PartnerScreenName": "sample string 5",
"ShareBonusName": "sample string 6",
"ShareBonusUrl": "sample string 7",
"ShareBonusScreen": "sample string 8",
"ChildrenScreen": true,
"ShareMobile": true,
"ShareMobileMessage": "sample string 9",
"ShareMobileUrl": "sample string 10",
"HistoryDetail": true,
"HistoryFeedback": true,
"HistoryFeedbackColor": "sample string 11",
"ClientFeedbackColor": "sample string 12",
"BackgroundColor": "sample string 13",
"ButtonColor": "sample string 14",
"BonusAddColor": "sample string 15",
"BonusRedeemColor": "sample string 16",
"QuestionnaireShown": true,
"GoodsCatalogId": 1,
"CampaignSubtitleShown": true,
"CampaignTitleShown": true,
"CampaignDetailShown": true,
"CampaignNumberShown": true,
"ClientFeedbackColorTitle": "sample string 17",
"ClientFeedbackColorSystem": "sample string 18",
"ClientFeedbackColorText": "sample string 19",
"AllowEmailOnlineChequeShown": true,
"VersionMobile": "sample string 20",
"MarketUrl": "sample string 21",
"LevelsModalShown": true,
"LevelsModalType": "sample string 22",
"CardLevelsDetailShown": true,
"CardLevelsDetailType": "sample string 23",
"SearchGoodShown": true,
"SearchGoodType": "sample string 24",
"SearchGoodsNameShown": true,
"CallbackShown": true,
"PriceListUrl": "sample string 25",
"BottomMenuFixed": true,
"BasketContragentDepends": true,
"CardMergeShown": true,
"CardMergeName": "sample string 26",
"SetFriendPhoneShown": true,
"SetFriendPhoneType": "sample string 27",
"UrlServiceVidget": "sample string 28",
"PageForCloseServiceVidget": "sample string 29",
"FullFormRegistration": true,
"UrlPersonalData": "sample string 30",
"CouponShown": true,
"CouponShownType": 64,
"CouponShownName": "sample string 31",
"CustomPushModalShown": true,
"CustomPushModalTitle": "sample string 32",
"CustomPushModalText": "sample string 33",
"WithConfig": true,
"ScreenConfigId": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 34"
}
application/xml, text/xml
<MobileOperatorCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MobileRequest"> <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 34</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 1</ActionType> <AgreementUrl>sample string 4</AgreementUrl> <AllowEmailOnlineChequeShown>true</AllowEmailOnlineChequeShown> <BackgroundColor>sample string 13</BackgroundColor> <BasketContragentDepends>true</BasketContragentDepends> <BonusAddColor>sample string 15</BonusAddColor> <BonusRedeemColor>sample string 16</BonusRedeemColor> <BottomMenuFixed>true</BottomMenuFixed> <ButtonColor>sample string 14</ButtonColor> <CallbackShown>true</CallbackShown> <CampaignDetailShown>true</CampaignDetailShown> <CampaignNumberShown>true</CampaignNumberShown> <CampaignSubtitleShown>true</CampaignSubtitleShown> <CampaignTitleShown>true</CampaignTitleShown> <CardLevelsDetailShown>true</CardLevelsDetailShown> <CardLevelsDetailType>sample string 23</CardLevelsDetailType> <CardMergeName>sample string 26</CardMergeName> <CardMergeShown>true</CardMergeShown> <ChildrenScreen>true</ChildrenScreen> <ClientFeedbackColor>sample string 12</ClientFeedbackColor> <ClientFeedbackColorSystem>sample string 18</ClientFeedbackColorSystem> <ClientFeedbackColorText>sample string 19</ClientFeedbackColorText> <ClientFeedbackColorTitle>sample string 17</ClientFeedbackColorTitle> <CouponShown>true</CouponShown> <CouponShownName>sample string 31</CouponShownName> <CouponShownType>64</CouponShownType> <CustomPushModalShown>true</CustomPushModalShown> <CustomPushModalText>sample string 33</CustomPushModalText> <CustomPushModalTitle>sample string 32</CustomPushModalTitle> <FullFormRegistration>true</FullFormRegistration> <GoodsCatalogId>1</GoodsCatalogId> <HistoryDetail>true</HistoryDetail> <HistoryFeedback>true</HistoryFeedback> <HistoryFeedbackColor>sample string 11</HistoryFeedbackColor> <LevelsModalShown>true</LevelsModalShown> <LevelsModalType>sample string 22</LevelsModalType> <LogUrl>sample string 3</LogUrl> <MarketUrl>sample string 21</MarketUrl> <PageForCloseServiceVidget>sample string 29</PageForCloseServiceVidget> <PartnerScreenName>sample string 5</PartnerScreenName> <Phone>sample string 2</Phone> <PriceListUrl>sample string 25</PriceListUrl> <QuestionnaireShown>true</QuestionnaireShown> <ScreenConfigId>1</ScreenConfigId> <SearchGoodShown>true</SearchGoodShown> <SearchGoodType>sample string 24</SearchGoodType> <SearchGoodsNameShown>true</SearchGoodsNameShown> <SetFriendPhoneShown>true</SetFriendPhoneShown> <SetFriendPhoneType>sample string 27</SetFriendPhoneType> <ShareBonusName>sample string 6</ShareBonusName> <ShareBonusScreen>sample string 8</ShareBonusScreen> <ShareBonusUrl>sample string 7</ShareBonusUrl> <ShareMobile>true</ShareMobile> <ShareMobileMessage>sample string 9</ShareMobileMessage> <ShareMobileUrl>sample string 10</ShareMobileUrl> <UrlPersonalData>sample string 30</UrlPersonalData> <UrlServiceVidget>sample string 28</UrlServiceVidget> <VersionMobile>sample string 20</VersionMobile> <WithConfig>true</WithConfig> </MobileOperatorCreateRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
MobileOperatorCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<MobileOperatorCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MobileResponse"> <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> </MobileOperatorCreateResponse>