Redeem token

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 9: Line 9:
|responsecode=200 OK
|responsecode=200 OK
|response=<?xml version="1.0" encoding="UTF-8"?>
|response=<?xml version="1.0" encoding="UTF-8"?>
-
<result ver="ePrize Web Services 1.0">
+
<result ver="1.0">
-
<result>
+
<token>
-
<token>
+
<id>{token}</id>
-
<id>{token}</id>
+
<profile>{profile}</profile>
-
<profile>{profile}</profile>
+
<game>{game}</game>
-
<game>{game}</game>
+
<redeemed>true</redeemed>
-
<redeemed>true</redeemed>
+
<awards>
-
<awards>
+
<prizes>
-
<prizes>
+
<prize>/v1/{apikey}/game/{game}/prize/{prize}</prize>
-
<prize>/v1/{apikey}/game/{game}/prize/{prize}</prize>
+
</prizes>
-
</prizes>
+
</awards>
-
</awards>
+
</token>
-
</token>
+
-
</result>
+
-
<status>1</status>
+
</result>
</result>
}}
}}
Line 32: Line 29:
|responsecode=200 OK
|responsecode=200 OK
|response=<?xml version="1.0" encoding="UTF-8"?>
|response=<?xml version="1.0" encoding="UTF-8"?>
-
<result ver="ePrize Web Services 1.0">
+
<result ver="1.0">
-
<result>
+
<token>
-
<token>
+
<id>{token}</id>
-
<id>{token}</id>
+
<profile>{profile}</profile>
-
<profile>{profile}</profile>
+
<game>{game}</game>
-
<game>{game}</game>
+
<redeemed>true</redeemed>
-
<redeemed>true</redeemed>
+
<awards>
-
<awards>
+
<tokens>
-
<tokens>
+
<token>/v1/{apikey}/game/{game}/token/{token2}</prize>
-
<token>/v1/{apikey}/game/{game}/token/{token2}</prize>
+
</tokens>
-
</tokens>
+
</awards>
-
</awards>
+
</token>
-
</token>
+
-
</result>
+
-
<status>1</status>
+
</result>
</result>
}}
}}
Line 55: Line 49:
|responsecode=200 OK
|responsecode=200 OK
|response=<?xml version="1.0" encoding="UTF-8"?>
|response=<?xml version="1.0" encoding="UTF-8"?>
-
<result ver="ePrize Web Services 1.0">
+
<result ver="1.0">
-
<result>
+
<token>
-
<token>
+
<id>{token}</id>
-
<id>{token}</id>
+
<profile>{profile}</profile>
-
<profile>{profile}</profile>
+
<game>{game}</game>
-
<game>{game}</game>
+
<redeemed>true</redeemed>
-
<redeemed>true</redeemed>
+
<awards/>
-
<awards/>
+
</token>
-
</token>
+
-
</result>
+
-
<status>1</status>
+
</result>
</result>
}}
}}
Line 74: Line 65:
|responsecode=404 Not Found
|responsecode=404 Not Found
|response=<?xml version="1.0" encoding="UTF-8"?>
|response=<?xml version="1.0" encoding="UTF-8"?>
-
<result ver="ePrize Web Services 1.0">
+
<result ver="1.0">
-
<result/>
+
<status>0</status>
<status>0</status>
</result>
</result>

Revision as of 17:42, 14 May 2009

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="1.0">
  <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>


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="1.0">
  <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>


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="1.0">
  <token>
    <id>{token}</id>
    <profile>{profile}</profile>
    <game>{game}</game>
    <redeemed>true</redeemed>
    <awards/>
  </token>
</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="1.0">
  <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