Contest API
From ePrize Developers Wiki
| Line 21: | Line 21: | ||
| [[Get All Contest Entries for a Profile]] | | [[Get All Contest Entries for a Profile]] | ||
| GET | | GET | ||
| - | | /v1/{apikey}/profile/{profileId}/contest/entry | + | | /v1/{apikey}/profile/{profileId}.{webkey}/contest/entry |
|} | |} | ||
</div> | </div> | ||
| Line 70: | Line 70: | ||
| [[Fetch Profile Contest History]] | | [[Fetch Profile Contest History]] | ||
| GET | | GET | ||
| - | | /v1/{apikey}/profile/{profileId}/contest/history | + | | /v1/{apikey}/profile/{profileId}.{webkey}/contest/history |
|} | |} | ||
</div> | </div> | ||
Revision as of 18:36, 19 April 2011
Contest Overview
The ePrize contest service provides an API for hosting an essay, photo, or video contest, with submission, rating, and voting capabilities. Your API key must be configured for contest for these resources to work properly.
Contests can work on text fields (essays) or binary files (images). To operate on contest entries, the following resources are provided. Entries are associated with profiles, so a profile must be created first.
| Create Contest Entry | POST | /v1/{apikey}/contest/entry |
| Fetch a Contest Entry | GET | /v1/{apikey}/contest/entry/{entryId} |
| Get All Contest Entries for a Profile | GET | /v1/{apikey}/profile/{profileId}.{webkey}/contest/entry |
After an entry is created, a number of other resources can modify its metadata by voting or rating the entry. Votes and ratings are subject to certain limits which will be configured in your API key. A tattle is a way for users to inform you of a photo that they disapprove of.
| Rate a Contest Entry | POST | /v1/{apikey}/contest/entry/{entryId}/rate |
| Tattle on a Contest Entry | POST | /v1/{apikey}/contest/entry/{entryId}/tattle |
| Vote on a Contest Entry | POST | /v1/{apikey}/contest/entry/{entryId}/vote |
| Send a Contest Entry Link | POST | /v1/{apikey}/contest/entry/{entryId}/send_a_link |
An entry gallery can be created by using the gallery resource and parsing the resulting XML (or JSON) to create a paginated gallery of any approved entries.
| Browse Contest Gallery | GET | /v1/{apikey}/contest/gallery |
| Fetch Contest Leaderboard | GET | /v1/{apikey}/contest/most-popular |
| Fetch Profile Contest History | GET | /v1/{apikey}/profile/{profileId}.{webkey}/contest/history |
