POST api/system/TransferDataClientAction
Создание, изменение и получение информации о клиенте программы лояльности внешним сервисом
Request Information
URI Parameters
None.
Body Parameters
TransferDataClientActionRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
ActionType |
Тип действия (Create, Update, Info) |
string |
None. |
ServiceId |
Идентификатор внешнего сервиса, который осуществляет запрос |
byte |
None. |
ClientControl |
Контрольная строка из таблицы clientcheckregistration, которая подтверждает возможность внешнего сервиса осуществлять действия по регистрации/изменению и получению информации |
string |
None. |
ClientId |
Идентификатор клиента для изменения или получения информации по нему |
integer |
None. |
Phone |
Номер телефона |
integer |
None. |
Name |
Имя |
string |
None. |
Surname |
Фамилия |
string |
None. |
Patronymic |
Отчество |
string |
None. |
|
string |
None. |
|
Birthdate |
Дата рождения |
date |
None. |
AllowSms |
Разрешение на коммуникации по смс; по умолчанию ставим 1 |
boolean |
None. |
AllowEmail |
Разрешение на коммуникации по email; по умолчанию ставим 1 |
boolean |
None. |
AllowPush |
Разрешение на коммуникации по push; по умолчанию ставим 1 |
boolean |
None. |
Gender |
Пол (1 = мужской; 0 = женский, null - не указан) |
boolean |
None. |
AgreePersonalData |
Разрешение на обработку персональных данных; по умолчанию ставим 1 |
boolean |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "ActionType": "sample string 2", "ServiceId": 64, "ClientControl": "sample string 3", "ClientId": 1, "Phone": 1, "Name": "sample string 4", "Surname": "sample string 5", "Patronymic": "sample string 6", "Email": "sample string 7", "Birthdate": "2024-04-29T17:50:02.8650923+03:00", "AllowSms": true, "AllowEmail": true, "AllowPush": true, "Gender": true, "AgreePersonalData": true, "Operator": 1, "Token": 1, "SiteCode": "sample string 8" }
application/xml, text/xml
<TransferDataClientActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SystemRequest"> <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 8</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 2</ActionType> <AgreePersonalData>true</AgreePersonalData> <AllowEmail>true</AllowEmail> <AllowPush>true</AllowPush> <AllowSms>true</AllowSms> <Birthdate>2024-04-29T17:50:02.8650923+03:00</Birthdate> <ClientControl>sample string 3</ClientControl> <ClientId>1</ClientId> <Email>sample string 7</Email> <Gender>true</Gender> <Name>sample string 4</Name> <Patronymic>sample string 6</Patronymic> <Phone>1</Phone> <PosCode>sample string 1</PosCode> <ServiceId>64</ServiceId> <Surname>sample string 5</Surname> </TransferDataClientActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
TransferDataClientActionResponseName | Description | Type | Additional information |
---|---|---|---|
Client |
Идентификатор созданного клиента |
integer |
None. |
Clients |
Массив клиентов |
Collection of TransferDataClientActionClientRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Client": 1, "Clients": [ { "Client": 1, "Card": 1, "Phone": 1, "Gender": true, "Birthdate": "2024-04-29T17:50:03.1619714+03:00", "LevelName": "sample string 1", "FullBalance": 1.0, "Balance": 1.0, "CardStatus": "sample string 2", "RegDate": "2024-04-29T17:50:03.1619714+03:00" }, { "Client": 1, "Card": 1, "Phone": 1, "Gender": true, "Birthdate": "2024-04-29T17:50:03.1619714+03:00", "LevelName": "sample string 1", "FullBalance": 1.0, "Balance": 1.0, "CardStatus": "sample string 2", "RegDate": "2024-04-29T17:50:03.1619714+03:00" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<TransferDataClientActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SystemResponse"> <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> <Client>1</Client> <Clients> <TransferDataClientActionResponse.TransferDataClientActionClientRow> <Balance>1</Balance> <Birthdate>2024-04-29T17:50:03.1619714+03:00</Birthdate> <Card>1</Card> <CardStatus>sample string 2</CardStatus> <Client>1</Client> <FullBalance>1</FullBalance> <Gender>true</Gender> <LevelName>sample string 1</LevelName> <Phone>1</Phone> <RegDate>2024-04-29T17:50:03.1619714+03:00</RegDate> </TransferDataClientActionResponse.TransferDataClientActionClientRow> <TransferDataClientActionResponse.TransferDataClientActionClientRow> <Balance>1</Balance> <Birthdate>2024-04-29T17:50:03.1619714+03:00</Birthdate> <Card>1</Card> <CardStatus>sample string 2</CardStatus> <Client>1</Client> <FullBalance>1</FullBalance> <Gender>true</Gender> <LevelName>sample string 1</LevelName> <Phone>1</Phone> <RegDate>2024-04-29T17:50:03.1619714+03:00</RegDate> </TransferDataClientActionResponse.TransferDataClientActionClientRow> </Clients> </TransferDataClientActionResponse>