Documentation

View Contest Entry

From KickApps Documentation

Jump to: navigation, search
This method retrieves a contest entry for a given contest (by contestEntryId).

Contents

Authentication

Requires an Admin or Webmaster API Token.

Call Structure

http://api.kickapps.com/rest/contestentry/view/{asid}

URL Arguments

as required The site Id to search. as is unique for each of the affiliate's sites.

HTTP Headers

HTTP Method must be POST

Post Arguments

t required the user token generated via the "Create Token" API call.
contestId int,required The ID of the contest.
contestEntryId int,required The ID of the contest Entry.
callback String The name of your JavaScript callback function.

Response

Success

{
    "status": 1,
    "contestEntryId": "1234",
    "contestEntry": {
        "contestId": "1234",
        "title": "This is my contest entry",
        "description": "This is a description of my contest entry",
        "rating": "4",
        "votes": "200",
        "numOfTimesRated1": "3",
        "numOfTimesRated2": "17",
        "numOfTimesRated3": "10",
        "numOfTimesRated4": "20",
        "numOfTimesRated5": "150",
        "user_id": "43567",
        "submittedTime": "<Posix Time>",
        "mediaId": "43567",
        "mediaType": "photo",
        "rank": 2,
        "communityRank": 1,
        "adminTags": [
            "homepage",
            "feature" 
        ],
        "tags": [
            "cool",
            "fantastic",
            "music" 
        ],
        "media": "http://www.kickapps.com/media",
        "mediaCaption": "This is a description of the media",
        "altText": "Some alternative text to show in browsers",
        "published": True,
        "flagged": False 
    }
}

Failure

{
    "status": -1,
    "errid": "123",
    "error": "Error Message"
}

Error Codes

1 Invalid Token
40 contestId not found (or not an int).
41 contestEntryId not found (or not an int)
44 token required
53 contestId and contestEntryId mismatch
Retrieved from "http://www.kickapps.com/documentation/index.php/View_Contest_Entry"