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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ID":0,"ConsumablePriceID":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"ResponseType":"Success","RemainingCredits":0,"GiftID":0}