Enter Contest

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Current revision (20:02, 13 August 2013) (edit) (undo)
 
Line 7: Line 7:
|paramsrequired='''body''': for an essay, this is the content of the entry
|paramsrequired='''body''': for an essay, this is the content of the entry
-
'''upload_url''': upload URL retrieved from [[Photo Upload Key]]
+
'''photo''': photo URL retrieved from [[Photo Upload Key]]
'''title''': entry title
'''title''': entry title

Current revision

API Home Page :: Contest

Summary

Create a contest entry associated with this profile, specifying basic entry metadata such as a description and category. The API key will be preconfigured to expect a certain type of entry type (essay content, or binary image data). For binary image submissions, the form must be sent using Content-Type: multipart/form-data

Resource

/v1/{apikey}/contest/entry

Valid Methods

POST

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key.

Parameters Required

body: for an essay, this is the content of the entry

photo: photo URL retrieved from Photo Upload Key

title: entry title

category: category to be entered into

description: description of entry (usually has a character or word length associated)

original_work: send 'yes' after the user has agreed this is his own work

official_rules: send 'yes' after the user agrees his entry conforms to the rules of the contest.

Note: other fields may be required depending on the configuration of your API Key



Example: Submitting a blank entry

Summary

Demonstrates validation errors on missing parameters

Request

profile: http://{client}.api.promo.eprize.com/v1/{apikey}/profile/{uid}.{webkey}

Response

HTTP Status Code: 400 Bad Request


<?xml version="1.0" encoding="UTF-8" ?>
 <result>
   <input_error>
     <name>body</name>
     <error>NULL</error>
   </input_error>
   <input_error>
     <name>title</name>
     <error>NULL</error>
   </input_error>
   <input_error>
     <name>category</name>
     <error>NULL</error>
   </input_error>
   <input_error>
     <name>original_work</name>
     <error>NULL</error>
   </input_error>
   <input_error>
     <name>official_rules</name>
     <error>NULL</error>
   </input_error>
 </result>

Notes

The {profile} value that is seen in the request of this call is the canonical URL of the profile that the entry is associated with.

Example: Submitting a entry successfully

Request

profile: http://{client}.api.promo.eprize.com/v1/{apikey}/profile/{uid}.{webkey}
body: "this is the body of my essay"
title: "this is the title of my essay"
original_work: yes
official_rules: yes
category: 1

Response

HTTP Status Code: 201 Created

HTTP Redirect Location: /v1/{apikey}/contest/entry/{entryid}

<?xml version="1.0" encoding="UTF-8" ?>
 <result>
   <entry>
     <body>this is the body of my essay</body>
     <category>1</category>
     <city>PLEASANT RIDGE</city>
     <description></description>
     <entry_id>1</entry_id>
     <entry_state>transmuted</entry_state>
     <first_name>Todd</first_name>
     <last_name>C</last_name>
     <rating_ave>0.000</rating_ave>
     <rating_count>0</rating_count>
     <state>MI</state>
     <title>this is the title of my essay</title>
     <views>0</views>
     <votes>0</votes>
   </entry>
 </result>

Notes

The {profile} value that is seen in the request of this call is the canonical URL of the profile that the entry is associated with.

Personal tools