POST api/client/ClientFriendsAction

Привязка друга клиентом и получение статистической информации о друзьях и бонусах за приведённых друзей клиента

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PosCode	Код торговой точки	string	None.
ActionType	Тип действия (Create, Update, Info)	string	None.
Client	Идентификатор клиента	integer	None.
PhoneFriend	Телефон друга, которого нужно привязать к клиенту	integer	None.
Start	Последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.)	integer	None.
Length	Количество записей, которые нужно вернуть	integer	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PosCode": "sample string 1",
  "ActionType": "sample string 2",
  "Client": 1,
  "PhoneFriend": 1,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:

<ClientFriendsActionRequest 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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Client>1</Client>
  <Length>1</Length>
  <PhoneFriend>1</PhoneFriend>
  <PosCode>sample string 1</PosCode>
  <Start>1</Start>
</ClientFriendsActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientFriendsActionResponse

Name	Description	Type	Additional information
FriendPhone	Телефон друга, который привязан к клиенту	integer	None.
Rules	Текст правил механика "приведи друга"	string	None.
BonusAdded	Всего начислено клиенту за приведённых друзей	decimal number	None.
FriendsAll	Всего друзей, который клиент привёл в программу лояльности	integer	None.
FriendsNoAction	Всего друзей, которые НЕ выполнили целевого действия, чтобы считаться "приведёнными", чтобы получить бонусы	integer	None.
TotalRows	Количество записей, которые попали в выборку	integer	None.
TotalRowsSelect	Количество записей, которые вернулись в массиве ответа на запрос	integer	None.
Friends	Массив информации о друзьях клиента	Collection of ClientFriendsActionFriendRow	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FriendPhone": 1,
  "Rules": "sample string 1",
  "BonusAdded": 1.0,
  "FriendsAll": 1,
  "FriendsNoAction": 1,
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Friends": [
    {
      "Id": 1,
      "Phone": 1,
      "ProcTime": "2024-04-29T14:45:59.1376551+03:00",
      "Bonus": 1.0,
      "NoAction": true
    },
    {
      "Id": 1,
      "Phone": 1,
      "ProcTime": "2024-04-29T14:45:59.1376551+03:00",
      "Bonus": 1.0,
      "NoAction": true
    }
  ],
  "ErrorCode": 2,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:

<ClientFriendsActionResponse 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">2</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</Message>
  <BonusAdded>1</BonusAdded>
  <FriendPhone>1</FriendPhone>
  <Friends>
    <ClientFriendsActionResponse.ClientFriendsActionFriendRow>
      <Bonus>1</Bonus>
      <Id>1</Id>
      <NoAction>true</NoAction>
      <Phone>1</Phone>
      <ProcTime>2024-04-29T14:45:59.1376551+03:00</ProcTime>
    </ClientFriendsActionResponse.ClientFriendsActionFriendRow>
    <ClientFriendsActionResponse.ClientFriendsActionFriendRow>
      <Bonus>1</Bonus>
      <Id>1</Id>
      <NoAction>true</NoAction>
      <Phone>1</Phone>
      <ProcTime>2024-04-29T14:45:59.1376551+03:00</ProcTime>
    </ClientFriendsActionResponse.ClientFriendsActionFriendRow>
  </Friends>
  <FriendsAll>1</FriendsAll>
  <FriendsNoAction>1</FriendsNoAction>
  <Rules>sample string 1</Rules>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ClientFriendsActionResponse>