Contest API
From ePrize Developers Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
{{Logo}} | {{Logo}} | ||
[[API Home Page]] | [[API Home Page]] | ||
| + | |||
| + | == 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|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 [[Create profile|profiles]], so a profile must be created first. | ||
<div class="api_table"> | <div class="api_table"> | ||
{| | {| | ||
|- | |- | ||
| - | | [[Enter Contest]] | + | | [[Enter Contest|Create Contest Entry]] |
| - | | POST /v1/{apikey}/contest/entry | + | | POST |
| - | + | | /v1/{apikey}/contest/entry | |
|- | |- | ||
| - | | | + | | [[Fetch a Contest Entry]] |
| - | | GET /v1/{apikey}/contest/entry/{entryId} | + | | GET |
| - | + | | /v1/{apikey}/contest/entry/{entryId} | |
|- | |- | ||
| - | | | + | | [[Get All Contest Entries for a Profile]] |
| - | | GET /v1/{apikey}/profile/{profileId}/contest/entry | + | | GET |
| - | | | + | | /v1/{apikey}/profile/{profileId}/contest/entry |
| + | |} | ||
| + | </div> | ||
| + | |||
| + | |||
| + | 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|API key]]. A [[Tattle on a Contest Entry|tattle]] is a way for users to inform you of a photo that they disapprove of. | ||
| + | |||
| + | <div class="api_table"> | ||
| + | {| | ||
|- | |- | ||
| - | | | + | | [[Rate a Contest Entry]] |
| - | | POST /v1/{apikey}/contest/entry/{entryId}/rate | + | | POST |
| - | + | | /v1/{apikey}/contest/entry/{entryId}/rate | |
|- | |- | ||
| - | | | + | | [[Tattle on a Contest Entry]] |
| - | | POST /v1/{apikey}/contest/entry/{entryId}/tattle | + | | POST |
| - | + | | /v1/{apikey}/contest/entry/{entryId}/tattle | |
|- | |- | ||
| - | | | + | | [[Vote on a Contest Entry]] |
| - | | POST /v1/{apikey}/contest/entry/{entryId}/vote | + | | POST |
| - | + | | /v1/{apikey}/contest/entry/{entryId}/vote | |
|- | |- | ||
| - | | | + | | [[Send a Contest Entry Link]] |
| - | | POST /v1/{apikey}/contest/entry/{entryId}/send_a_link | + | | POST |
| - | | | + | | /v1/{apikey}/contest/entry/{entryId}/send_a_link |
| + | |} | ||
| + | </div> | ||
| + | |||
| + | |||
| + | An entry gallery can be created by using the [[Browse Contest Gallery|gallery]] resource and parsing the resulting XML (or JSON) to create a paginated gallery of any approved entries. | ||
| + | |||
| + | <div class="api_table"> | ||
| + | {| | ||
|- | |- | ||
| - | | | + | | [[Browse Contest Gallery]] |
| - | | GET /v1/{apikey}/contest/gallery | + | | GET |
| - | | | + | | /v1/{apikey}/contest/gallery |
| + | |} | ||
| + | </div> | ||
| + | |||
| + | <div class="api_table"> | ||
| + | {| | ||
|- | |- | ||
| - | | | + | | [[Fetch Contest Leaderboard]] |
| - | | GET /v1/{apikey}/contest/most-popular | + | | GET |
| - | + | | /v1/{apikey}/contest/most-popular | |
|- | |- | ||
| - | | | + | | [[Fetch Profile Contest History]] |
| - | | GET /v1/{apikey}/profile/{profileId}/contest/history | + | | GET |
| - | + | | /v1/{apikey}/profile/{profileId}/contest/history | |
|} | |} | ||
</div> | </div> | ||
| - | |||
| - | The ePrize contest service provides an API for hosting an essay, photo, or video contest, with submission, rating, and voting capabilities. | ||
Revision as of 17:55, 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}/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}/contest/history |
