POST api/cheque/ChequeBonusAction
Списание активных/неактивных/всех бонусов по чеку с указанным источником бонусов и возвращает активный/неактивный/весь остаток бонусов по чеку
Request Information
URI Parameters
None.
Body Parameters
ChequeBonusActionRequestName | Description | Type | Additional information |
---|---|---|---|
ActionType |
Тип действия |
string |
None. |
ChequeId |
Идентификатор чека, по которому будут произведены действия |
integer |
None. |
RedeemActive |
Признак списания только активных бонусов по чеку |
boolean |
None. |
RedeemNoActive |
Признак, списания только НЕ активных бонусов по чеку |
boolean |
None. |
RedeemAll |
Признак, списания всех бонусов по чеку |
boolean |
None. |
Source |
Источник списания бонусов |
byte |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "ActionType": "sample string 1", "ChequeId": 1, "RedeemActive": true, "RedeemNoActive": true, "RedeemAll": true, "Source": 64, "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<ChequeBonusActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.ChequeRequest"> <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> <ActionType>sample string 1</ActionType> <ChequeId>1</ChequeId> <RedeemActive>true</RedeemActive> <RedeemAll>true</RedeemAll> <RedeemNoActive>true</RedeemNoActive> <Source>64</Source> </ChequeBonusActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ChequeBonusActionResponseName | Description | Type | Additional information |
---|---|---|---|
Redeemed |
Кол-во бонусов, котоорое было списано |
decimal number |
None. |
Data |
Массив данных |
Collection of ChequeBonusActionDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Redeemed": 1.0, "Data": [ { "RemainActive": 1.0, "RemainNoActive": 1.0, "RemainAll": 1.0 }, { "RemainActive": 1.0, "RemainNoActive": 1.0, "RemainAll": 1.0 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<ChequeBonusActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ChequeResponse"> <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> <Data> <ChequeBonusActionResponse.ChequeBonusActionDataRow> <RemainActive>1</RemainActive> <RemainAll>1</RemainAll> <RemainNoActive>1</RemainNoActive> </ChequeBonusActionResponse.ChequeBonusActionDataRow> <ChequeBonusActionResponse.ChequeBonusActionDataRow> <RemainActive>1</RemainActive> <RemainAll>1</RemainAll> <RemainNoActive>1</RemainNoActive> </ChequeBonusActionResponse.ChequeBonusActionDataRow> </Data> <Redeemed>1</Redeemed> </ChequeBonusActionResponse>