RHP_API

<back to all web services

PurchaseConsumable

Requires Authentication
The following routes are available for this service:
POST/User/Consumable/Purchase
PurchaseConsumable Parameters:
NameParameterData TypeRequiredDescription
ConsumablePriceIDbodyintNoConsumable ID
MetaDatabodystringNoAdditional data to support request
PurchaseConsumableResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ResponseTypeformPurchaseConsumableResponseTypeNo
RemainingCreditsformintNo
BoostResponseformBoostResponseDataNo
BoostResponseData Parameters:
NameParameterData TypeRequiredDescription
BoostExpiryformDateTime?No

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 /User/Consumable/Purchase HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ConsumablePriceID: 0,
	MetaData: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	ResponseType: Success,
	RemainingCredits: 0,
	BoostResponse: 
	{
		BoostExpiry: 0001-01-01
	}
}