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 Foundation
import ServiceStack

public class GiftCardSearchRequest : Codable
{
    public var giftCardTypeId:Int?
    public var scope:String?
    public var ownerId:Int?
    public var status:String?
    public var codeLast4:String?

    required public init(){}
}

public class GiftCardSearchResult : Codable
{
    public var items:[GiftCardSummary] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class GiftCardSummary : Codable
{
    public var id:Int?
    public var giftCardTypeId:Int?
    public var codeLast4:String?
    public var scope:String?
    public var scopeOwnerId:Int?
    public var currency:String?
    public var initialValueMinor:Int?
    public var currentBalanceMinor:Int?
    public var status:String?
    public var activatedAt:Date?
    public var expiresAt:Date?
    public var createdAt:Date?
    public var buyerName:String?
    public var buyerEmail:String?
    public var buyerPhone:String?
    public var paymentId:String?
    public var paymentMethodId:String?
    public var purchasePaymentReference:String?

    required public init(){}
}


Swift 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
}