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
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GiftCardSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val GiftCardTypeId:Int32 = new Int32() with get,set
        member val CodeLast4:String = null with get,set
        member val Scope:String = null with get,set
        member val ScopeOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Currency:String = null with get,set
        member val InitialValueMinor:Int32 = new Int32() with get,set
        member val CurrentBalanceMinor:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val ActivatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val BuyerName:String = null with get,set
        member val BuyerEmail:String = null with get,set
        member val BuyerPhone:String = null with get,set
        member val PaymentId:String = null with get,set
        member val PaymentMethodId:String = null with get,set
        member val PurchasePaymentReference:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardSearchResult() = 
        member val Items:ResizeArray<GiftCardSummary> = new ResizeArray<GiftCardSummary>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardSearchRequest() = 
        member val GiftCardTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Scope:String = null with get,set
        member val OwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Status:String = null with get,set
        member val CodeLast4:String = null with get,set

F# 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
}