TicketUserServices

<back to all web services

GiftCardLedgerRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET/GiftCard/Ledger/{GiftCardId}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GiftCardLedgerRequest
    {
        public Integer giftCardId = null;
        
        public Integer getGiftCardId() { return giftCardId; }
        public GiftCardLedgerRequest setGiftCardId(Integer value) { this.giftCardId = value; return this; }
    }

    public static class GiftCardLedgerResult
    {
        public GiftCardSummary card = null;
        public ArrayList<GiftCardTransaction> transactions = null;
        public Integer statusCode = null;
        public String message = null;
        
        public GiftCardSummary getCard() { return card; }
        public GiftCardLedgerResult setCard(GiftCardSummary value) { this.card = value; return this; }
        public ArrayList<GiftCardTransaction> getTransactions() { return transactions; }
        public GiftCardLedgerResult setTransactions(ArrayList<GiftCardTransaction> value) { this.transactions = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public GiftCardLedgerResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public GiftCardLedgerResult setMessage(String value) { this.message = value; return this; }
    }

    public static class GiftCardSummary
    {
        public Integer id = null;
        public Integer giftCardTypeId = null;
        public String codeLast4 = null;
        public String scope = null;
        public Integer scopeOwnerId = null;
        public String currency = null;
        public Integer initialValueMinor = null;
        public Integer currentBalanceMinor = null;
        public String status = null;
        public Date activatedAt = null;
        public Date expiresAt = null;
        public Date createdAt = null;
        public String buyerName = null;
        public String buyerEmail = null;
        public String buyerPhone = null;
        public String paymentId = null;
        public String paymentMethodId = null;
        public String purchasePaymentReference = null;
        
        public Integer getId() { return id; }
        public GiftCardSummary setId(Integer value) { this.id = value; return this; }
        public Integer getGiftCardTypeId() { return giftCardTypeId; }
        public GiftCardSummary setGiftCardTypeId(Integer value) { this.giftCardTypeId = value; return this; }
        public String getCodeLast4() { return codeLast4; }
        public GiftCardSummary setCodeLast4(String value) { this.codeLast4 = value; return this; }
        public String getScope() { return scope; }
        public GiftCardSummary setScope(String value) { this.scope = value; return this; }
        public Integer getScopeOwnerId() { return scopeOwnerId; }
        public GiftCardSummary setScopeOwnerId(Integer value) { this.scopeOwnerId = value; return this; }
        public String getCurrency() { return currency; }
        public GiftCardSummary setCurrency(String value) { this.currency = value; return this; }
        public Integer getInitialValueMinor() { return initialValueMinor; }
        public GiftCardSummary setInitialValueMinor(Integer value) { this.initialValueMinor = value; return this; }
        public Integer getCurrentBalanceMinor() { return currentBalanceMinor; }
        public GiftCardSummary setCurrentBalanceMinor(Integer value) { this.currentBalanceMinor = value; return this; }
        public String getStatus() { return status; }
        public GiftCardSummary setStatus(String value) { this.status = value; return this; }
        public Date getActivatedAt() { return activatedAt; }
        public GiftCardSummary setActivatedAt(Date value) { this.activatedAt = value; return this; }
        public Date getExpiresAt() { return expiresAt; }
        public GiftCardSummary setExpiresAt(Date value) { this.expiresAt = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public GiftCardSummary setCreatedAt(Date value) { this.createdAt = value; return this; }
        public String getBuyerName() { return buyerName; }
        public GiftCardSummary setBuyerName(String value) { this.buyerName = value; return this; }
        public String getBuyerEmail() { return buyerEmail; }
        public GiftCardSummary setBuyerEmail(String value) { this.buyerEmail = value; return this; }
        public String getBuyerPhone() { return buyerPhone; }
        public GiftCardSummary setBuyerPhone(String value) { this.buyerPhone = value; return this; }
        public String getPaymentId() { return paymentId; }
        public GiftCardSummary setPaymentId(String value) { this.paymentId = value; return this; }
        public String getPaymentMethodId() { return paymentMethodId; }
        public GiftCardSummary setPaymentMethodId(String value) { this.paymentMethodId = value; return this; }
        public String getPurchasePaymentReference() { return purchasePaymentReference; }
        public GiftCardSummary setPurchasePaymentReference(String value) { this.purchasePaymentReference = value; return this; }
    }

    public static class GiftCardTransaction
    {
        public Integer id = null;
        public Integer giftCardId = null;
        public String kind = null;
        public Integer amountMinor = null;
        public String status = null;
        public Date holdExpiresAt = null;
        public Integer relatedHoldId = null;
        public String orderPaymentReference = null;
        public Integer eventId = null;
        public Integer ownerId = null;
        public String idempotencyKey = null;
        public Date createdAt = null;
        public String note = null;
        
        public Integer getId() { return id; }
        public GiftCardTransaction setId(Integer value) { this.id = value; return this; }
        public Integer getGiftCardId() { return giftCardId; }
        public GiftCardTransaction setGiftCardId(Integer value) { this.giftCardId = value; return this; }
        public String getKind() { return kind; }
        public GiftCardTransaction setKind(String value) { this.kind = value; return this; }
        public Integer getAmountMinor() { return amountMinor; }
        public GiftCardTransaction setAmountMinor(Integer value) { this.amountMinor = value; return this; }
        public String getStatus() { return status; }
        public GiftCardTransaction setStatus(String value) { this.status = value; return this; }
        public Date getHoldExpiresAt() { return holdExpiresAt; }
        public GiftCardTransaction setHoldExpiresAt(Date value) { this.holdExpiresAt = value; return this; }
        public Integer getRelatedHoldId() { return relatedHoldId; }
        public GiftCardTransaction setRelatedHoldId(Integer value) { this.relatedHoldId = value; return this; }
        public String getOrderPaymentReference() { return orderPaymentReference; }
        public GiftCardTransaction setOrderPaymentReference(String value) { this.orderPaymentReference = value; return this; }
        public Integer getEventId() { return eventId; }
        public GiftCardTransaction setEventId(Integer value) { this.eventId = value; return this; }
        public Integer getOwnerId() { return ownerId; }
        public GiftCardTransaction setOwnerId(Integer value) { this.ownerId = value; return this; }
        public String getIdempotencyKey() { return idempotencyKey; }
        public GiftCardTransaction setIdempotencyKey(String value) { this.idempotencyKey = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public GiftCardTransaction setCreatedAt(Date value) { this.createdAt = value; return this; }
        public String getNote() { return note; }
        public GiftCardTransaction setNote(String value) { this.note = value; return this; }
    }

}

Java GiftCardLedgerRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /GiftCard/Ledger/{GiftCardId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"card":{"id":0,"giftCardTypeId":0,"codeLast4":"String","scope":"String","scopeOwnerId":0,"currency":"String","initialValueMinor":0,"currentBalanceMinor":0,"status":"String","activatedAt":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000","createdAt":"0001-01-01T00:00:00.0000000","buyerName":"String","buyerEmail":"String","buyerPhone":"String","paymentId":"String","paymentMethodId":"String","purchasePaymentReference":"String"},"transactions":[{"id":0,"giftCardId":0,"kind":"String","amountMinor":0,"status":"String","holdExpiresAt":"0001-01-01T00:00:00.0000000","relatedHoldId":0,"orderPaymentReference":"String","eventId":0,"ownerId":0,"idempotencyKey":"String","createdAt":"0001-01-01T00:00:00.0000000","note":"String"}],"statusCode":0,"message":"String"}