Fetch prize

From ePrize Developers Wiki

API Home Page :: Games and Awards

Summary

TODO: Write me.

Example: Requesting a Valid Prize

Summary

This demonstrates a good request for a prize that exists.

Response

HTTP Status Code: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
  <prize>
    <id>{prize}</id>
    <description>{prize-description}</description>
    <game>{game}</game>
  </prize>
</result>

Example: Requesting An Invalid Prize

Summary

This demonstrates a good request for a prize that does not 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

The {profile} value identifies the profile that the prize was awarded to, or null if the prize has not been awarded. The {prize-name} value is the name of the prize for tracking purposes and may not make sense to a consumer. The client is expected to translate the name before displaying it.

The claim action represents a resource that will help a consumer claim the prize. This action is only present if ePrize is performing prize fulfilment.

Request representation: empty

Response:
200 OK
game: {game},
profile: {profile},
description: {prize-description},
actions: [
  claim: {prize-center-url}
]

Response if prize doesn't exist:
404 Not Found