TicketUserServices

<back to all web services

GiftCardRedeemRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Redeem
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GiftCardRedeemRequest
    {
        public Integer holdId = null;
        public String code = null;
        public Integer amountMinor = null;
        public Integer eventId = null;
        public Integer targetOwnerId = null;
        public String orderPaymentReference = null;
        public String idempotencyKey = null;
        
        public Integer getHoldId() { return holdId; }
        public GiftCardRedeemRequest setHoldId(Integer value) { this.holdId = value; return this; }
        public String getCode() { return code; }
        public GiftCardRedeemRequest setCode(String value) { this.code = value; return this; }
        public Integer getAmountMinor() { return amountMinor; }
        public GiftCardRedeemRequest setAmountMinor(Integer value) { this.amountMinor = value; return this; }
        public Integer getEventId() { return eventId; }
        public GiftCardRedeemRequest setEventId(Integer value) { this.eventId = value; return this; }
        public Integer getTargetOwnerId() { return targetOwnerId; }
        public GiftCardRedeemRequest setTargetOwnerId(Integer value) { this.targetOwnerId = value; return this; }
        public String getOrderPaymentReference() { return orderPaymentReference; }
        public GiftCardRedeemRequest setOrderPaymentReference(String value) { this.orderPaymentReference = value; return this; }
        public String getIdempotencyKey() { return idempotencyKey; }
        public GiftCardRedeemRequest setIdempotencyKey(String value) { this.idempotencyKey = value; return this; }
    }

    public static class GiftCardRedeemResult
    {
        public Boolean ok = null;
        public String reason = null;
        public LocalizedMessage message = null;
        public Integer redeemedAmountMinor = null;
        public Integer newBalanceMinor = null;
        public Integer transactionId = null;
        public String settlementTag = null;
        public Integer statusCode = null;
        
        public Boolean isOk() { return ok; }
        public GiftCardRedeemResult setOk(Boolean value) { this.ok = value; return this; }
        public String getReason() { return reason; }
        public GiftCardRedeemResult setReason(String value) { this.reason = value; return this; }
        public LocalizedMessage getMessage() { return message; }
        public GiftCardRedeemResult setMessage(LocalizedMessage value) { this.message = value; return this; }
        public Integer getRedeemedAmountMinor() { return redeemedAmountMinor; }
        public GiftCardRedeemResult setRedeemedAmountMinor(Integer value) { this.redeemedAmountMinor = value; return this; }
        public Integer getNewBalanceMinor() { return newBalanceMinor; }
        public GiftCardRedeemResult setNewBalanceMinor(Integer value) { this.newBalanceMinor = value; return this; }
        public Integer getTransactionId() { return transactionId; }
        public GiftCardRedeemResult setTransactionId(Integer value) { this.transactionId = value; return this; }
        public String getSettlementTag() { return settlementTag; }
        public GiftCardRedeemResult setSettlementTag(String value) { this.settlementTag = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public GiftCardRedeemResult setStatusCode(Integer value) { this.statusCode = value; return this; }
    }

    public static class LocalizedMessage
    {
        public String is = null;
        public String en = null;
        
        public String getIs() { return is; }
        public LocalizedMessage setIs(String value) { this.is = value; return this; }
        public String getEn() { return en; }
        public LocalizedMessage setEn(String value) { this.en = value; return this; }
    }

}

Java GiftCardRedeemRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GiftCard/Redeem HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"holdId":0,"code":"String","amountMinor":0,"eventId":0,"targetOwnerId":0,"orderPaymentReference":"String","idempotencyKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ok":false,"reason":"String","message":{"is":"String","en":"String"},"redeemedAmountMinor":0,"newBalanceMinor":0,"transactionId":0,"settlementTag":"String","statusCode":0}