POST api/system/BonusHoldCancelProcess

Отмена холдирования бонусов на картах клиентов по заданным критериям: период, точка продаж, список идентификаторов холдирования

Request Information

URI Parameters

None.

Body Parameters

BonusHoldCancelProcessRequest
NameDescriptionTypeAdditional information
PosCode

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

string

None.

BonusHoldPos

Идентификатор торговой точки, у которой нужно отменить все захолдированные бонусы

integer

None.

BonusHolds

Список идентификаторов холдирования для отмены холдирования

Collection of BonusHoldCancelProcessBonusHoldRow

None.

Client

Идентификатор клиента, по которому нужно произвести операцию отмены холдирования

integer

None.

BegDate

Дата начала периода холдированных бонусов, которые нужно отменить

date

None.

EndDate

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

date

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "BonusHoldPos": 1,
  "BonusHolds": [
    {
      "Id": 1,
      "BonusHold": 1
    },
    {
      "Id": 1,
      "BonusHold": 1
    }
  ],
  "Client": 1,
  "BegDate": "2024-06-20T06:13:43.5356102+03:00",
  "EndDate": "2024-06-20T06:13:43.5356102+03:00",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<BonusHoldCancelProcessRequest 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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-06-20T06:13:43.5356102+03:00</BegDate>
  <BonusHoldPos>1</BonusHoldPos>
  <BonusHolds>
    <BonusHoldCancelProcessRequest.BonusHoldCancelProcessBonusHoldRow>
      <BonusHold>1</BonusHold>
      <Id>1</Id>
    </BonusHoldCancelProcessRequest.BonusHoldCancelProcessBonusHoldRow>
    <BonusHoldCancelProcessRequest.BonusHoldCancelProcessBonusHoldRow>
      <BonusHold>1</BonusHold>
      <Id>1</Id>
    </BonusHoldCancelProcessRequest.BonusHoldCancelProcessBonusHoldRow>
  </BonusHolds>
  <Client>1</Client>
  <EndDate>2024-06-20T06:13:43.5356102+03:00</EndDate>
  <PosCode>sample string 1</PosCode>
</BonusHoldCancelProcessRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BonusHoldCancelProcessResponse
NameDescriptionTypeAdditional information
BonusHoldCancelProcessData

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

Collection of BonusHoldCancelProcessDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "BonusHoldCancelProcessData": [
    {
      "Id": 1,
      "BonusHold": 1,
      "BonusCancelHold": 1
    },
    {
      "Id": 1,
      "BonusHold": 1,
      "BonusCancelHold": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<BonusHoldCancelProcessResponse 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>
  <BonusHoldCancelProcessData>
    <BonusHoldCancelProcessResponse.BonusHoldCancelProcessDataRow>
      <BonusCancelHold>1</BonusCancelHold>
      <BonusHold>1</BonusHold>
      <Id>1</Id>
    </BonusHoldCancelProcessResponse.BonusHoldCancelProcessDataRow>
    <BonusHoldCancelProcessResponse.BonusHoldCancelProcessDataRow>
      <BonusCancelHold>1</BonusCancelHold>
      <BonusHold>1</BonusHold>
      <Id>1</Id>
    </BonusHoldCancelProcessResponse.BonusHoldCancelProcessDataRow>
  </BonusHoldCancelProcessData>
</BonusHoldCancelProcessResponse>