RHP_API

<back to all web services

PurchaseConsumable

Requires Authentication
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 .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<PurchaseConsumable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <ConsumablePriceID>0</ConsumablePriceID>
  <MetaData>String</MetaData>
</PurchaseConsumable>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<PurchaseConsumableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <BoostResponse>
    <BoostExpiry>0001-01-01T00:00:00</BoostExpiry>
  </BoostResponse>
  <RemainingCredits>0</RemainingCredits>
  <ResponseType>Success</ResponseType>
  <Success>false</Success>
</PurchaseConsumableResponse>

    </soap12:Body>
</soap12:Envelope>