Contest API

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
m
Current revision (14:22, 31 March 2014) (edit) (undo)
 
(9 intermediate revisions not shown.)
Line 1: Line 1:
-
<font style="color: red; font-style: italic;">Survey API calls will not be available until October 2010.</font>
 
{{Logo}}
{{Logo}}
[[API Home Page]]
[[API Home Page]]
 +
 +
== Contest Overview ==
 +
 +
The HelloWorld 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">
{|
{|
|-
|-
-
| [[Get Survey Info For Profile]]
+
| [[Photo Upload Key|Get Key for Photo Upload]]
-
| GET /v1/{apikey}/profile/{id}/survey/{surveyId}
+
| POST
-
| Returns information about a survey for a specific profile
+
| /v1/{apikey}/contest/photo_upload_key
|-
|-
-
| [[Get Next Survey For Profile]]
+
| [[Enter Contest|Create Contest Entry]]
-
| GET /v1/{apikey}/profile/{id}/survey
+
| POST
-
| Gets the next survey a profile can take
+
| /v1/{apikey}/contest/entry
|-
|-
-
| [[Submit Survey]]
+
| [[Fetch a Contest Entry]]
-
| POST /v1/{apikey}/survey/{surveyId}
+
| GET
-
| Submit survey answers
+
| /v1/{apikey}/contest/entry/{entryId}
|-
|-
-
| [[Get Survey Info]]
+
| [[Get All Contest Entries for a Profile]]
-
| POST /v1/{apikey}/survey/{surveyId}
+
| GET
-
| Get non-profile specific survey info.
+
| /v1/{apikey}/profile/{profileId}.{webkey}/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">
 +
{|
|-
|-
-
| [[Enumerate Surveys]]
+
| [[Rate a Contest Entry]]
-
| GET /v1/{apikey}/surveys
+
| POST
-
| Get available surveys
+
| /v1/{apikey}/contest/entry/{entryId}/rate
|-
|-
-
| [[Get Survey Summary]]
+
| [[Tattle on a Contest Entry]]
-
| GET /v1/{apikey}/survey/{surveyId}/summary
+
| POST
-
| Get a summary for a survey
+
| /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
|}
|}
</div>
</div>
-
The ePrize contest service provides an API for hosting an essay, photo, or video contest, with submission, rating, and voting capabilities.
+
 
 +
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
 +
|}
 +
</div>
 +
 
 +
<div class="api_table">
 +
{|
 +
|-
 +
| [[Fetch Contest Leaderboard]]
 +
| GET
 +
| /v1/{apikey}/contest/most-popular
 +
|-
 +
| [[Fetch Profile Contest History]]
 +
| GET
 +
| /v1/{apikey}/profile/{profileId}.{webkey}/contest/history
 +
|}
 +
</div>

Current revision

API Home Page

Contest Overview

The HelloWorld 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.

Get Key for Photo Upload POST /v1/{apikey}/contest/photo_upload_key
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
Retrieved from "https://code.helloworld.com/wiki/index.php/Contest_API"
Personal tools