Award sweepstakes entry

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
{{RESTfulAPI
{{RESTfulAPI
|crumbs=[[API Home Page]] :: [[Games and Awards]]
|crumbs=[[API Home Page]] :: [[Games and Awards]]
-
|summary=Awards the user an [[Sweepstakes Entry|entry]] in the sweepstakes. User must be [[Eligibility|eligible]] to receive an [[Sweepstakes Entry|entry]].
+
|summary=Awards the profile an [[Sweepstakes Entry|entry]] into the sweepstakes.
|resource=/v1/{apikey}/game/{gameid}/sweeps
|resource=/v1/{apikey}/game/{gameid}/sweeps
|methods=POST
|methods=POST

Revision as of 18:06, 6 April 2011

API Home Page :: Games and Awards

Summary

Awards the profile an entry into the sweepstakes.

Resource

/v1/{apikey}/game/{gameid}/sweeps

Valid Methods

POST

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key.

gameId: Game Identifier for the Sweepstakes into which the entry will be awarded. (A constant value provided to you by ePrize)

Parameters Required

profile: Canonical Location of a user profile. See: Fetch Profile by Key.



Example: Successfully Awarding a Sweeps Entry

Summary

This demonstrates successfully awarding a sweepstakes entry to a user.

Request 

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

Response

HTTP Status Code: 201 Created 


<?xml version="1.0" encoding="UTF-8" ?>
<result ver="1.0">
  <sweepsEntry>
    <whenEarned>{date-time}</whenEarned>
    <game>{gameid}</game>
  </sweepsEntry>
</result>

Notes

The {profile} value that is seen in the request and response of this call is the canonical URL of the profile that the token should be awarded to.

This URL can be easily attacked by the owner of a profile because the owner knows his own canonical profile URL. Award limits create an upper bound on the attack damage.

Example: Awarding Sweeps Entry to Invalid Profile

Summary

This demonstrates attempting to award a sweepstakes entry to a profile resource that doesn't exist.

Request 

profile: foo

Response

HTTP Status Code: 400 Bad Request 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
  <reason>Unable to validate the provided profile.</reason>
  <status>0</status>
</result>


Example: Awarding Sweeps Entry to a Limited Profile

Summary

This demonstrates attempting to overaward sweepstakes entries to a user. For example, the promotion is setup to give out 3 sweeps entries per day per user, and this would be a users 4th attempt in one day.


Response

HTTP Status Code: 403 Forbidden 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
</result>


Retrieved from "https://code.helloworld.com/wiki/index.php/Award_sweepstakes_entry"