| GET | /Competition/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompetitionID | form | int | No | |
| Prize | form | string | No | Prize description |
| QuestionBlurb | form | string | No | Question Title |
| Question | form | string | No | Question Text |
| TermsCondition | form | string | No | Terms and Conditions text |
| StartDate | form | DateTime | No | Cometition Start Date |
| EndDate | form | DateTime | No | Cometition End Date |
| IsNameRequired | form | bool | No | Determines if the Name field should be displayed |
| IsEmailRequired | form | bool | No | Determines if the Email field should be displayed |
| IsPhoneRequired | form | bool | No | Determines if the Phone field should be displayed |
| IsAddressRequired | form | bool | No | Determines if the Address field should be displayed |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CompetitionID: 0,
Prize: String,
QuestionBlurb: String,
Question: String,
TermsCondition: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsNameRequired: False,
IsEmailRequired: False,
IsPhoneRequired: False,
IsAddressRequired: False
}