View Contest
From KickApps Documentation
This method returns a contest with all of its administration information. This method should only be used for administering the contest (should not be used to display contest to the member facing site).
Authentication
Requires an Admin or Webmaster API Token.
Call Structure
http://api.kickapps.com/rest/contest/view/{as}
URL Arguments
|
|
|
| {asid}
| required
| The site Id to search. as is unique for each of the affiliate's sites.
|
HTTP Method must be POST
Post Arguments
|
|
|
| t
| required
| The user token generated via the "Create Token" API call. (Webmaster/Admin/Editor token only.)
|
| contestId
| required
| The ID of the contest.
|
| callback
| String, optional
| The name of your JavaScript callback function.
|
Response
Success
{
"status":1,
"contestId":"1234",
"contest":{
"name":"A cool contest",
"description":"The description of my cool contest.",
"rules":"This is what you can and can't do in this contest.",
"contestMediaType":"photo",
"votingEnabled":True,
"votingType":"thumbs",
"announceDate":"##########",
"submissionStartDate":"##########",
"submissionEndDate":"##########",
"votingStartDate":"##########",
"votingEndDate":"##########",
"timeZone":"EST5EDT",
"locale":"en_US",
"winnerAnnounceDate":"##########",
"submissionPhaseUpdate":"We're now in the submission phase",
"votingPhaseUpdate":"We're now in the voting phase.",
"overPhaseUpdate":"The contest is now over.",
"published":True,
"completed":False,
"winnerId":"4567",
"communityWinnerId":"27654",
"contestType":"automatic",
"tags":[
"cool",
"awesome",
"fun"
],
"admintags":[
"super",
"terrific",
"fabulous"
],
"contestGraphic":"http://www.kickapps.com/image.jpg",
"restriction1":"",
"restriction2":"",
"restriction3":"",
"entries":"12322",
"numOfTimesRated1":"130",
"numOfTimesRated2":"40",
"numOfTimesRated3":"60",
"numOfTimesRated4":""100,
"numOfTimesRated5":"12001",
"votes":"12321"
}
}
Failure
{"status": -1, "errorId": "123", "error": "Error Message"}
Error Codes
|
|
| 1
| Invalid Token
|
| 40
| contestId not found (or not an int).
|
| 44
| token required
|
Favorites
