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
GiftCardHoldRequest Parameters:
NameParameterData TypeRequiredDescription
CodebodystringNo
AmountMinorbodyint?No
EventIdbodyint?No
TargetOwnerIdbodyint?No
OrderPaymentReferencebodystringNo
IdempotencyKeybodystringNo
GiftCardHoldResult Parameters:
NameParameterData TypeRequiredDescription
OkformboolNo
ReasonformstringNo
MessageformLocalizedMessageNo
HoldIdformint?No
HeldAmountMinorformintNo
RemainingAvailableMinorformintNo
ExpiresAtformDateTime?No
StatusCodeformintNo
LocalizedMessage Parameters:
NameParameterData TypeRequiredDescription
IsformstringNo
EnformstringNo

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
}