RHP_API

<back to all web services

GetCurrentCompetition

Requires Authentication
The following routes are available for this service:
GET/Competition/{Id}
GetCurrentCompetition Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
Competition Parameters:
NameParameterData TypeRequiredDescription
CompetitionIDformintNo
PrizeformstringNoPrize description
QuestionBlurbformstringNoQuestion Title
QuestionformstringNoQuestion Text
TermsConditionformstringNoTerms and Conditions text
StartDateformDateTimeNoCometition Start Date
EndDateformDateTimeNoCometition End Date
IsNameRequiredformboolNoDetermines if the Name field should be displayed
IsEmailRequiredformboolNoDetermines if the Email field should be displayed
IsPhoneRequiredformboolNoDetermines if the Phone field should be displayed
IsAddressRequiredformboolNoDetermines if the Address field should be displayed

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /Competition/{Id} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CompetitionID":0,"Prize":"String","QuestionBlurb":"String","Question":"String","TermsCondition":"String","StartDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","IsNameRequired":false,"IsEmailRequired":false,"IsPhoneRequired":false,"IsAddressRequired":false}