TicketUserServices

<back to all web services

GiftCardHoldRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Hold

export class LocalizedMessage
{
    public is?: string;
    public en?: string;

    public constructor(init?: Partial<LocalizedMessage>) { (Object as any).assign(this, init); }
}

export class GiftCardHoldResult
{
    public ok?: boolean;
    public reason?: string;
    public message?: LocalizedMessage;
    public holdId?: number;
    public heldAmountMinor?: number;
    public remainingAvailableMinor?: number;
    public expiresAt?: string;
    public statusCode?: number;

    public constructor(init?: Partial<GiftCardHoldResult>) { (Object as any).assign(this, init); }
}

export class GiftCardHoldRequest
{
    public code?: string;
    public amountMinor?: number;
    public eventId?: number;
    public targetOwnerId?: number;
    public orderPaymentReference?: string;
    public idempotencyKey?: string;

    public constructor(init?: Partial<GiftCardHoldRequest>) { (Object as any).assign(this, init); }
}

TypeScript GiftCardHoldRequest 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/Hold HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	code: String,
	amountMinor: 0,
	eventId: 0,
	targetOwnerId: 0,
	orderPaymentReference: String,
	idempotencyKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ok: False,
	reason: String,
	message: 
	{
		is: String,
		en: String
	},
	holdId: 0,
	heldAmountMinor: 0,
	remainingAvailableMinor: 0,
	expiresAt: 0001-01-01,
	statusCode: 0
}