POST api/values/ClientInfo

Получение данных Участника по заданному номеру телефона или номеру карты.

Request Information

URI Parameters

None.

Body Parameters

GetClientInfoRequest
NameDescriptionTypeAdditional information
Card

номер карты

integer

None.

Phone

номер телефона

integer

None.

Client

номер телефона

integer

None.

LkTerminal

Признак вызова метода из ЛК

boolean

None.

ClientIShop

Идентификатор клиента в бд интернет-магазина которого хотят проверить на существование в лояльности

integer

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Card": 1,
  "Phone": 1,
  "Client": 1,
  "LkTerminal": true,
  "ClientIShop": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<GetClientInfoRequest 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 1</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Card>1</Card>
  <Client>1</Client>
  <ClientIShop>1</ClientIShop>
  <LkTerminal>true</LkTerminal>
  <Phone>1</Phone>
</GetClientInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetClientInfoResponse
NameDescriptionTypeAdditional information
ErrorCode

код ошибки

integer

None.

Message

сообщение об ошибке

string

None.

Card

Номер карты

integer

None.

Phone

Номер телефона

integer

None.

Surname

Фамилия

string

None.

Name

Имя

string

None.

Patronymic

Отчество

string

None.

Email

E-mail

string

None.

Birthdate

Дата рождения

date

None.

LastPurchaseDate

Дата последней покупки

date

None.

LastPurchaseAmount

Сумма последней покупки

decimal number

None.

AllowSms

Разрешение на коммуникацию по смс

boolean

None.

AllowEmail

Разрешение на коммуникацию по e-mail

boolean

None.

FullBalance

Полный баланс на карте

decimal number

None.

Balance

Активный баланс на карте

decimal number

None.

Condition

% начисления на уровне

string

None.

Id

Идентификатор клиента

integer

None.

Gender

Пол

integer

None.

PhoneValidated

Признак валидации номера телефона

boolean

None.

EmailValidated

Признак валидации e-mail

boolean

None.

RegDate

Дата регистрации в программе лояльности

date

None.

Promocode

Персональный промод клиента

string

None.

AllowPush

Разрешение на коммуникацию по apppush

boolean

None.

PurchaseSum

Сумма покупок за всё время по карте (сумма накоплений)

decimal number

None.

LevelId

Идентификатор уровня карты клиента

integer

None.

LevelName

Наименование уровня карты клиента

string

None.

CardStatus

Идентификатор статуса карты клиента (0 = активна; 1 = заблокирована; 2 = ограничена)

byte

None.

Purchases

Количество покупок, которое совершил клиент за всё время участия

integer

None.

LevelExceeds

Накопления на текущем уровне

decimal number

None.

SumNextLevel

Сумма денег, которую нужно потратить, чтобы перейти на следующий уровень

decimal number

None.

BonusStaff

Размер бонуса "сотрудника", который начисляется клиенту ежемесячно

decimal number

None.

CardOutNumber

Номер карты клиента, загруженный из внешней системы лояльности

integer

None.

BonusVip

Размер бонуса "vip клиента", который начисляется клиенту ежемесячно

decimal number

None.

RedeeminCheque

Списано бонусов за всё время

decimal number

None.

MobileBasketId

Идентификатор корзины товаров в мобильном приложении клиента

integer

None.

AllowEmailOnlineCheque

Признак разрешения пользователем отправлять ему на e-mail онлайн-чеки

boolean

None.

BonusRemain

Доступный для списания положительный, активный остаток бонусов

decimal number

None.

BonusHolded

Общая сумма захолдированных бонусов на карте

decimal number

None.

ContragentConfirm

Признак подтверждения клиента как контрагента во внешней системе (например в 1С)

boolean

None.

ContragentId

Идентификатор контрагента клиента во внешней системе

string

None.

BalanceNoActive

Неактивный баланс на карте

decimal number

None.

ChildrensInfo

Массив данных детей клиентов

Collection of ChildrenInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 1,
  "Message": "sample string 2",
  "Card": 1,
  "Phone": 1,
  "Surname": "sample string 3",
  "Name": "sample string 4",
  "Patronymic": "sample string 5",
  "Email": "sample string 6",
  "Birthdate": "2022-08-16T22:51:29.7794359+03:00",
  "LastPurchaseDate": "2022-08-16T22:51:29.7794359+03:00",
  "LastPurchaseAmount": 1.0,
  "AllowSms": true,
  "AllowEmail": true,
  "FullBalance": 1.0,
  "Balance": 1.0,
  "Condition": "sample string 7",
  "Id": 1,
  "Gender": 1,
  "PhoneValidated": true,
  "EmailValidated": true,
  "RegDate": "2022-08-16T22:51:29.7794359+03:00",
  "Promocode": "sample string 8",
  "AllowPush": true,
  "PurchaseSum": 1.0,
  "LevelId": 1,
  "LevelName": "sample string 9",
  "CardStatus": 64,
  "Purchases": 1,
  "LevelExceeds": 1.0,
  "SumNextLevel": 1.0,
  "BonusStaff": 1.0,
  "CardOutNumber": 1,
  "BonusVip": 1.0,
  "RedeeminCheque": 1.0,
  "MobileBasketId": 1,
  "AllowEmailOnlineCheque": true,
  "BonusRemain": 1.0,
  "BonusHolded": 1.0,
  "ContragentConfirm": true,
  "ContragentId": "sample string 10",
  "BalanceNoActive": 1.0,
  "ChildrensInfo": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Birthdate": "2022-08-16T22:51:29.7794359+03:00",
      "Gender": true,
      "Age": 64
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Birthdate": "2022-08-16T22:51:29.7794359+03:00",
      "Gender": true,
      "Age": 64
    }
  ]
}

application/xml, text/xml

Sample:
<GetClientInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <AllowEmail>true</AllowEmail>
  <AllowEmailOnlineCheque>true</AllowEmailOnlineCheque>
  <AllowPush>true</AllowPush>
  <AllowSms>true</AllowSms>
  <Balance>1</Balance>
  <BalanceNoActive>1</BalanceNoActive>
  <Birthdate>2022-08-16T22:51:29.7794359+03:00</Birthdate>
  <BonusHolded>1</BonusHolded>
  <BonusRemain>1</BonusRemain>
  <BonusStaff>1</BonusStaff>
  <BonusVip>1</BonusVip>
  <Card>1</Card>
  <CardOutNumber>1</CardOutNumber>
  <CardStatus>64</CardStatus>
  <ChildrensInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
    <d2p1:ChildrenInfo>
      <d2p1:Age>64</d2p1:Age>
      <d2p1:Birthdate>2022-08-16T22:51:29.7794359+03:00</d2p1:Birthdate>
      <d2p1:Gender>true</d2p1:Gender>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:ChildrenInfo>
    <d2p1:ChildrenInfo>
      <d2p1:Age>64</d2p1:Age>
      <d2p1:Birthdate>2022-08-16T22:51:29.7794359+03:00</d2p1:Birthdate>
      <d2p1:Gender>true</d2p1:Gender>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:ChildrenInfo>
  </ChildrensInfo>
  <Condition>sample string 7</Condition>
  <ContragentConfirm>true</ContragentConfirm>
  <ContragentId>sample string 10</ContragentId>
  <Email>sample string 6</Email>
  <EmailValidated>true</EmailValidated>
  <ErrorCode>1</ErrorCode>
  <FullBalance>1</FullBalance>
  <Gender>1</Gender>
  <Id>1</Id>
  <LastPurchaseAmount>1</LastPurchaseAmount>
  <LastPurchaseDate>2022-08-16T22:51:29.7794359+03:00</LastPurchaseDate>
  <LevelExceeds>1</LevelExceeds>
  <LevelId>1</LevelId>
  <LevelName>sample string 9</LevelName>
  <Message>sample string 2</Message>
  <MobileBasketId>1</MobileBasketId>
  <Name>sample string 4</Name>
  <Patronymic>sample string 5</Patronymic>
  <Phone>1</Phone>
  <PhoneValidated>true</PhoneValidated>
  <Promocode>sample string 8</Promocode>
  <PurchaseSum>1</PurchaseSum>
  <Purchases>1</Purchases>
  <RedeeminCheque>1</RedeeminCheque>
  <RegDate>2022-08-16T22:51:29.7794359+03:00</RegDate>
  <SumNextLevel>1</SumNextLevel>
  <Surname>sample string 3</Surname>
</GetClientInfoResponse>