TicketUserServices

<back to all web services

GiftCardValidateRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
POST/GiftCard/Validate
GiftCardValidateRequest Parameters:
NameParameterData TypeRequiredDescription
CodebodystringNo
EventIdbodyint?No
TargetOwnerIdbodyint?No
AmountMinorbodyint?No
GiftCardValidateResult Parameters:
NameParameterData TypeRequiredDescription
OkformboolNo
ReasonformstringNo
MessageformLocalizedMessageNo
StatusformstringNo
AvailableMinorformintNo
ApplicableMinorformintNo
ScopeformstringNo
ScopeOwnerIdformint?No
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/Validate HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	ok: False,
	reason: String,
	message: 
	{
		is: String,
		en: String
	},
	status: String,
	availableMinor: 0,
	applicableMinor: 0,
	scope: String,
	scopeOwnerId: 0,
	expiresAt: 0001-01-01,
	statusCode: 0
}