POST api/system/BonusHoldHistory

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

Request Information

URI Parameters

None.

Body Parameters

BonusHoldHistoryRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки пользователя

 string

None.
BonusHoldPos

Входной фильтр: идентификатор торговой точки, которая инициировала холдирование бонусов

 integer

None.
Client

Входной фильтр: идентификатор клиента

 integer

None.
BonusHold

Входной фильтр: идентификатор бонуса холдирования

 integer

None.
ChequeNumber

Входной фильтр: список идентификаторов клиентов, у которых нужно отменить все холдированные бонусы

 string

None.
BegDate

Входной фильтр: дата начала периода холдирования бонусов

 date

None.
EndDate

Входной фильтр: дата окончания периода холдированных бонусов

 date

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",
  "BonusHoldPos": 1,
  "Client": 1,
  "BonusHold": 1,
  "ChequeNumber": "sample string 2",
  "BegDate": "2024-04-29T14:42:20.2373538+03:00",
  "EndDate": "2024-04-29T14:42:20.2373538+03:00",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<BonusHoldHistoryRequest 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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-04-29T14:42:20.2373538+03:00</BegDate>
  <BonusHold>1</BonusHold>
  <BonusHoldPos>1</BonusHoldPos>
  <ChequeNumber>sample string 2</ChequeNumber>
  <Client>1</Client>
  <EndDate>2024-04-29T14:42:20.2373538+03:00</EndDate>
  <Length>1</Length>
  <PosCode>sample string 1</PosCode>
  <Start>1</Start>
</BonusHoldHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BonusHoldHistoryResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей, которые попали в выборку

 integer

None.
TotalRowsSelect

Количество записей, которые вернулись в ответе на запрос

 integer

None.
BonusHoldHistoryBonusHolds

Захолдированные бонусы

 Collection of BonusHoldHistoryBonusHoldRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "BonusHoldHistoryBonusHolds": [
    {
      "Id": 1,
      "BonusHold": 1,
      "Client": 1,
      "HoldAmount": 1.0,
      "DateActionHold": "2024-04-29T14:42:20.4873501+03:00",
      "ChequeNumber": "sample string 1",
      "BonusHoldPos": 1,
      "BonusHoldPosName": "sample string 2",
      "ActionHold": "sample string 3",
      "Parent": 1
    },
    {
      "Id": 1,
      "BonusHold": 1,
      "Client": 1,
      "HoldAmount": 1.0,
      "DateActionHold": "2024-04-29T14:42:20.4873501+03:00",
      "ChequeNumber": "sample string 1",
      "BonusHoldPos": 1,
      "BonusHoldPosName": "sample string 2",
      "ActionHold": "sample string 3",
      "Parent": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<BonusHoldHistoryResponse 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>
  <BonusHoldHistoryBonusHolds>
    <BonusHoldHistoryResponse.BonusHoldHistoryBonusHoldRow>
      <ActionHold>sample string 3</ActionHold>
      <BonusHold>1</BonusHold>
      <BonusHoldPos>1</BonusHoldPos>
      <BonusHoldPosName>sample string 2</BonusHoldPosName>
      <ChequeNumber>sample string 1</ChequeNumber>
      <Client>1</Client>
      <DateActionHold>2024-04-29T14:42:20.4873501+03:00</DateActionHold>
      <HoldAmount>1</HoldAmount>
      <Id>1</Id>
      <Parent>1</Parent>
    </BonusHoldHistoryResponse.BonusHoldHistoryBonusHoldRow>
    <BonusHoldHistoryResponse.BonusHoldHistoryBonusHoldRow>
      <ActionHold>sample string 3</ActionHold>
      <BonusHold>1</BonusHold>
      <BonusHoldPos>1</BonusHoldPos>
      <BonusHoldPosName>sample string 2</BonusHoldPosName>
      <ChequeNumber>sample string 1</ChequeNumber>
      <Client>1</Client>
      <DateActionHold>2024-04-29T14:42:20.4873501+03:00</DateActionHold>
      <HoldAmount>1</HoldAmount>
      <Id>1</Id>
      <Parent>1</Parent>
    </BonusHoldHistoryResponse.BonusHoldHistoryBonusHoldRow>
  </BonusHoldHistoryBonusHolds>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</BonusHoldHistoryResponse>