POST api/card/BalanceDetail

Получение информации об уровнях карты в программе, накоплениях и порогах накоплений

Request Information

URI Parameters

None.

Body Parameters

BalanceDetailRequest
NameDescriptionTypeAdditional information
Card

Номер карты

integer

None.

Phone

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

integer

None.

Client

Ид Клиента

integer

None.

Partner

Ид Партнера

integer

None.

PosCode

Код торговой точки

string

None.

ActCountDays

Кол-во дней от сегодня за который идет подсчет итоговой суммы бонусов что должна активироваться

integer

None.

ExpCountDays

Кол-во дней от сегодня за который идет подсчет итоговой суммы бонусов что должна сгореть

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Card": 1,
  "Phone": 1,
  "Client": 1,
  "Partner": 1,
  "PosCode": "sample string 1",
  "ActCountDays": 1,
  "ExpCountDays": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<BalanceDetailRequest 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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActCountDays>1</ActCountDays>
  <Card>1</Card>
  <Client>1</Client>
  <ExpCountDays>1</ExpCountDays>
  <Partner>1</Partner>
  <Phone>1</Phone>
  <PosCode>sample string 1</PosCode>
</BalanceDetailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BalanceDetailResponse
NameDescriptionTypeAdditional information
Client

Ид клиента

integer

None.

Phone

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

integer

None.

Card

Номер карты

integer

None.

FullBalance

Баланс карты

decimal number

None.

Balance

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

decimal number

None.

ActSumBonus

Cумма бонусов что активируется в течении указанного кол-ва дней

decimal number

None.

ExpSumBonus

Сумма бонусов что сгорят в течении указанного кол-ва дней

decimal number

None.

BalanceDetails

Коллекция с детализацией начисленных бонусов

Collection of BalanceDetail

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Client": 1,
  "Phone": 1,
  "Card": 1,
  "FullBalance": 1.0,
  "Balance": 2.0,
  "ActSumBonus": 3.0,
  "ExpSumBonus": 4.0,
  "BalanceDetails": [
    {
      "Id": 1,
      "BonusSource": 2,
      "BonusSourceName": "sample string 3",
      "Bonus": 4.0,
      "Remain": 5.0,
      "ExpiryDate": "2022-08-16T22:26:57.5924653+03:00",
      "ActiveDate": "2022-08-16T22:26:57.5924653+03:00"
    },
    {
      "Id": 1,
      "BonusSource": 2,
      "BonusSourceName": "sample string 3",
      "Bonus": 4.0,
      "Remain": 5.0,
      "ExpiryDate": "2022-08-16T22:26:57.5924653+03:00",
      "ActiveDate": "2022-08-16T22:26:57.5924653+03:00"
    }
  ],
  "ErrorCode": 5,
  "Message": "sample string 6"
}

application/xml, text/xml

Sample:
<BalanceDetailResponse 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">5</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 6</Message>
  <ActSumBonus>3</ActSumBonus>
  <Balance>2</Balance>
  <BalanceDetails>
    <BalanceDetailResponse.BalanceDetail>
      <ActiveDate>2022-08-16T22:26:57.5924653+03:00</ActiveDate>
      <Bonus>4</Bonus>
      <BonusSource>2</BonusSource>
      <BonusSourceName>sample string 3</BonusSourceName>
      <ExpiryDate>2022-08-16T22:26:57.5924653+03:00</ExpiryDate>
      <Id>1</Id>
      <Remain>5</Remain>
    </BalanceDetailResponse.BalanceDetail>
    <BalanceDetailResponse.BalanceDetail>
      <ActiveDate>2022-08-16T22:26:57.5924653+03:00</ActiveDate>
      <Bonus>4</Bonus>
      <BonusSource>2</BonusSource>
      <BonusSourceName>sample string 3</BonusSourceName>
      <ExpiryDate>2022-08-16T22:26:57.5924653+03:00</ExpiryDate>
      <Id>1</Id>
      <Remain>5</Remain>
    </BalanceDetailResponse.BalanceDetail>
  </BalanceDetails>
  <Card>1</Card>
  <Client>1</Client>
  <ExpSumBonus>4</ExpSumBonus>
  <FullBalance>1</FullBalance>
  <Phone>1</Phone>
</BalanceDetailResponse>