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.*


open class GiftCardSearchRequest
{
    var giftCardTypeId:Int? = null
    var scope:String? = null
    var ownerId:Int? = null
    var status:String? = null
    var codeLast4:String? = null
}

open class GiftCardSearchResult
{
    var items:ArrayList<GiftCardSummary> = ArrayList<GiftCardSummary>()
    var statusCode:Int? = null
    var message:String? = null
}

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

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