RHP_API

<back to all web services

GiveUserGift

Requires Authentication
The following routes are available for this service:
POST/Profile/{ID}/Gift
GiveUserGift Parameters:
NameParameterData TypeRequiredDescription
IDpathlongNoUser ID
ConsumablePriceIDbodyintNoConsumable Gift ID
GiveGiftResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ResponseTypeformPurchaseConsumableResponseTypeNo
RemainingCreditsformintNo
GiftIDformintNo

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.

POST /Profile/{ID}/Gift HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<GiveGiftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <GiftID>0</GiftID>
  <RemainingCredits>0</RemainingCredits>
  <ResponseType>Success</ResponseType>
  <Success>false</Success>
</GiveGiftResponse>