TicketUserServices

<back to all web services

GiftCardSearchRequest

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

public class dtos
{

    public static class GiftCardSearchRequest
    {
        public Integer giftCardTypeId = null;
        public String scope = null;
        public Integer ownerId = null;
        public String status = null;
        public String codeLast4 = null;
        
        public Integer getGiftCardTypeId() { return giftCardTypeId; }
        public GiftCardSearchRequest setGiftCardTypeId(Integer value) { this.giftCardTypeId = value; return this; }
        public String getScope() { return scope; }
        public GiftCardSearchRequest setScope(String value) { this.scope = value; return this; }
        public Integer getOwnerId() { return ownerId; }
        public GiftCardSearchRequest setOwnerId(Integer value) { this.ownerId = value; return this; }
        public String getStatus() { return status; }
        public GiftCardSearchRequest setStatus(String value) { this.status = value; return this; }
        public String getCodeLast4() { return codeLast4; }
        public GiftCardSearchRequest setCodeLast4(String value) { this.codeLast4 = value; return this; }
    }

    public static class GiftCardSearchResult
    {
        public ArrayList<GiftCardSummary> items = null;
        public Integer statusCode = null;
        public String message = null;
        
        public ArrayList<GiftCardSummary> getItems() { return items; }
        public GiftCardSearchResult setItems(ArrayList<GiftCardSummary> value) { this.items = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public GiftCardSearchResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public GiftCardSearchResult 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; }
    }

}

Java GiftCardSearchRequest DTOs

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

HTTP + JSV

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

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

{
	giftCardTypeId: 0,
	scope: String,
	ownerId: 0,
	status: String,
	codeLast4: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			id: 0,
			giftCardTypeId: 0,
			codeLast4: String,
			scope: String,
			scopeOwnerId: 0,
			currency: String,
			initialValueMinor: 0,
			currentBalanceMinor: 0,
			status: String,
			activatedAt: 0001-01-01,
			expiresAt: 0001-01-01,
			createdAt: 0001-01-01,
			buyerName: String,
			buyerEmail: String,
			buyerPhone: String,
			paymentId: String,
			paymentMethodId: String,
			purchasePaymentReference: String
		}
	],
	statusCode: 0,
	message: String
}