RHP_API

<back to all web services

ValidateUserPromoCode

Checks if a Promo Code is valid. Will return 404 if code does not exists. If code is not valid: 1 - Code has expired, 2 - User has redeemed code (if called when authenticated)

The following routes are available for this service:
All Verbs/User/PromoCode/{Code}
ValidateUserPromoCode Parameters:
NameParameterData TypeRequiredDescription
CodepathstringNo
UserPromoCode Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo

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 /User/PromoCode/{Code} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<UserPromoCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Description>String</Description>
  <IsValid>false</IsValid>
</UserPromoCode>