RHP_API

<back to all web services

GetConsumables

Requires Authentication
The following routes are available for this service:
GET/Consumables/{GroupName}
GetConsumables Parameters:
NameParameterData TypeRequiredDescription
GroupNamepathConsumableGroupNameNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

GET /Consumables/{GroupName} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfConsumable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Consumable>
    <Category>None</Category>
    <ConsumableID>0</ConsumableID>
    <Data>String</Data>
    <Description>String</Description>
    <Diamonds>0</Diamonds>
    <GroupName>String</GroupName>
    <ImageURL>String</ImageURL>
    <Level>0</Level>
    <Name>String</Name>
    <Price>0</Price>
    <SortOrder>0</SortOrder>
    <Type>None</Type>
  </Consumable>
</ArrayOfConsumable>