Redeem token

From ePrize Developers Wiki

Revision as of 18:54, 9 April 2009 by Brian-quail (Talk | contribs)
Jump to: navigation, search

API Home Page :: Games and Awards

Summary

TODO: Write me.





Example: Redeem Token / Earn Prize

Summary

This demonstrates a good request to redeem a token that exists, and the user wins a prize as a result.


Response

HTTP Status Code: 200 OK 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="ePrize Web Services 1.0">
  <result>
    <token>
      <id>{token}</id>
      <profile>{profile}</profile>
      <game>{game}</game>
      <redeemed>true</redeemed>
      <awards>
        <prizes>
          <prize>/v1/{apikey}/game/{game}/prize/{prize}</prize>
        </prizes>
      </awards>
    </token>
  </result>
  <status>1</status>
</result>


Example: Redeem Token / Earn New Token

Summary

This demonstrates a good request to redeem a token that exists, and the user wins another token as a result.


Response

HTTP Status Code: 200 OK 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="ePrize Web Services 1.0">
  <result>
    <token>
      <id>{token}</id>
      <profile>{profile}</profile>
      <game>{game}</game>
      <redeemed>true</redeemed>
      <awards>
        <tokens>
          <token>/v1/{apikey}/game/{game}/token/{token2}</prize>
        </tokens>
      </awards>
    </token>
  </result>
  <status>1</status>
</result>


Example: Redeem Token / Earn Nothing :(

Summary

This demonstrates a good request to redeem a token that exists, and the user wins nothing as a result.


Response

HTTP Status Code: 200 OK 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="ePrize Web Services 1.0">
  <result>
    <token>
      <id>{token}</id>
      <profile>{profile}</profile>
      <game>{game}</game>
      <redeemed>true</redeemed>
      <awards/>
    </token>
  </result>
  <status>1</status>
</result>


Example: Redeem Token That Doesn't Exist

Summary

This demonstrates a good request to redeem a token that doesn't exist.


Response

HTTP Status Code: 404 Not Found 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="ePrize Web Services 1.0">
  <result/>
  <status>0</status>
</result>


Extra Notes

A successful redemption changes the representation of the token. The list of awards is immediately available on the resource /v1/{apikey}/profile/{profile}/awards. Tokens awarded are available on the resource /v1/{apikey}/profile/{profile}/tokens until they are redeemed. 

Response if request invalid:
400 Bad Request
Entity body describing failed validations

Response if token already redeemed:
405 Conflict

Response if limit reached:
403 Forbidden
Retrieved from "https://code.helloworld.com/wiki/index.php/Redeem_token"
Personal tools