TicketUserServices

<back to all web services

OwnerCardPurchaseQuoteRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:ReadData
The following routes are available for this service:
POST/OwnerCards/Purchase/Quote
OwnerCardPurchaseQuoteRequest Parameters:
NameParameterData TypeRequiredDescription
OwnerCardTypeIdbodyintNo
GiftCardCodebodystringNo
IdempotencyKeybodystringNo
IsRecurringbodyboolNo
OwnerCardPurchaseQuoteResult Parameters:
NameParameterData TypeRequiredDescription
OwnerCardTypeIdformintNo
OwnerIdformintNo
CurrencyformstringNo
PriceMinorformintNo
GiftAppliedMinorformintNo
RemainingMinorformintNo
GiftHoldIdformint?No
FullyCoveredByGiftCardformboolNo
RequiresCardMandateformboolNo
GiftRejectedReasonformstringNo
GiftMessageformLocalizedMessageNo
StatusCodeformintNo
MessageformstringNo
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 /OwnerCards/Purchase/Quote HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ownerCardTypeId: 0,
	giftCardCode: String,
	idempotencyKey: String,
	isRecurring: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ownerCardTypeId: 0,
	ownerId: 0,
	currency: String,
	priceMinor: 0,
	giftAppliedMinor: 0,
	remainingMinor: 0,
	giftHoldId: 0,
	fullyCoveredByGiftCard: False,
	requiresCardMandate: False,
	giftRejectedReason: String,
	giftMessage: 
	{
		is: String,
		en: String
	},
	statusCode: 0,
	message: String
}