Validate and consume code

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
<font style="color: red; font-style: italic;">Code Services API calls will not be available until September 2009.</font>
+
<font style="color: red; font-style: italic;">Code Services API calls will not be available until October 2009.</font>
{{RESTfulAPI
{{RESTfulAPI
|crumbs=[[API Home Page]] :: [[Code Services]]
|crumbs=[[API Home Page]] :: [[Code Services]]
Line 9: Line 9:
|summary=This demonstrates successfully validating and consuming a code.
|summary=This demonstrates successfully validating and consuming a code.
|request=profile: http://{client}.api.promo.eprize.com/v1/{apikey}/profile/{uid}
|request=profile: http://{client}.api.promo.eprize.com/v1/{apikey}/profile/{uid}
-
codeClass: {codeClass}
 
|responsecode=200 OK
|responsecode=200 OK
|response=<?xml version="1.0" encoding="UTF-8" ?>
|response=<?xml version="1.0" encoding="UTF-8" ?>

Revision as of 18:29, 14 October 2009

Code Services API calls will not be available until October 2009.

API Home Page :: Code Services

Summary

TODO: Fill me in.





Example: Successfully Validate & Consume a Code

Summary

This demonstrates successfully validating and consuming a code.

Request 

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

Response

HTTP Status Code: 200 OK 


<?xml version="1.0" encoding="UTF-8" ?>
<result ver="1.0">
  <codeResponse>
    <code>{code}</code>
    <codeClass>{codeClass}</codeClass>
    <metadata>{metadata}</metadata>
  </codeResponse>
</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.

Example: Attempting to Validate & Consume a Code with no Profile

Summary

This demonstrates an unsuccessful attempt at validating & consuming a code without providing a profile (or providing a bad one).

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>
</result>


Example: Attempting to Validate & Consume a Code for a code class that doesn't exist

Summary

This demonstrates an unsuccessful attempt at validating & consuming a code without providing a code class (or providing a bad one).

Request 

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

Response

HTTP Status Code: 400 Bad Request 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
  <reason>The specified code class does not exist.</reason>
</result>


Example: Attempting to Validate & Consume a Code that doesn't exist

Summary

This demonstrates an unsuccessful attempt at validating & consuming a code that doesn't exist.


Response

HTTP Status Code: 400 Bad Request 


<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
  <reason>The specified code does not exist.</reason>
</result>


Retrieved from "https://code.helloworld.com/wiki/index.php/Validate_and_consume_code"
Personal tools