| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Required permission: | Tickets.Add |
| POST | /GiftCard/Hold |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class GiftCardHoldRequest
{
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 String getCode() { return code; }
public GiftCardHoldRequest setCode(String value) { this.code = value; return this; }
public Integer getAmountMinor() { return amountMinor; }
public GiftCardHoldRequest setAmountMinor(Integer value) { this.amountMinor = value; return this; }
public Integer getEventId() { return eventId; }
public GiftCardHoldRequest setEventId(Integer value) { this.eventId = value; return this; }
public Integer getTargetOwnerId() { return targetOwnerId; }
public GiftCardHoldRequest setTargetOwnerId(Integer value) { this.targetOwnerId = value; return this; }
public String getOrderPaymentReference() { return orderPaymentReference; }
public GiftCardHoldRequest setOrderPaymentReference(String value) { this.orderPaymentReference = value; return this; }
public String getIdempotencyKey() { return idempotencyKey; }
public GiftCardHoldRequest setIdempotencyKey(String value) { this.idempotencyKey = value; return this; }
}
public static class GiftCardHoldResult
{
public Boolean ok = null;
public String reason = null;
public LocalizedMessage message = null;
public Integer holdId = null;
public Integer heldAmountMinor = null;
public Integer remainingAvailableMinor = null;
public Date expiresAt = null;
public Integer statusCode = null;
public Boolean isOk() { return ok; }
public GiftCardHoldResult setOk(Boolean value) { this.ok = value; return this; }
public String getReason() { return reason; }
public GiftCardHoldResult setReason(String value) { this.reason = value; return this; }
public LocalizedMessage getMessage() { return message; }
public GiftCardHoldResult setMessage(LocalizedMessage value) { this.message = value; return this; }
public Integer getHoldId() { return holdId; }
public GiftCardHoldResult setHoldId(Integer value) { this.holdId = value; return this; }
public Integer getHeldAmountMinor() { return heldAmountMinor; }
public GiftCardHoldResult setHeldAmountMinor(Integer value) { this.heldAmountMinor = value; return this; }
public Integer getRemainingAvailableMinor() { return remainingAvailableMinor; }
public GiftCardHoldResult setRemainingAvailableMinor(Integer value) { this.remainingAvailableMinor = value; return this; }
public Date getExpiresAt() { return expiresAt; }
public GiftCardHoldResult setExpiresAt(Date value) { this.expiresAt = value; return this; }
public Integer getStatusCode() { return statusCode; }
public GiftCardHoldResult 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GiftCard/Hold HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
code: String,
amountMinor: 0,
eventId: 0,
targetOwnerId: 0,
orderPaymentReference: String,
idempotencyKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ok: False,
reason: String,
message:
{
is: String,
en: String
},
holdId: 0,
heldAmountMinor: 0,
remainingAvailableMinor: 0,
expiresAt: 0001-01-01,
statusCode: 0
}