Validate code

From ePrize Developers Wiki

Revision as of 18:52, 7 August 2009 (edit) Brian-quail (Talk | contribs) ← Previous diff		Revision as of 19:05, 7 August 2009 (edit) (undo) Brian-quail (Talk | contribs) Next diff →
Line 14:		Line 14:
	<code>{code}</code>		<code>{code}</code>
	<codeClass>{codeClass}</codeClass>		<codeClass>{codeClass}</codeClass>
		+	<metadata>{metadata}</metadata>
	</codeResponse>		</codeResponse>
	</result>		</result>

---

Revision as of 19:05, 7 August 2009

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

API Home Page :: Code Services

Summary

TODO: Fill me in.

Example: Successfully validate a code

Summary

This demonstrates successfully validating a code.

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>

Example: Attempting to validate a code that doesn't exist

Summary

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

Response

HTTP Status Code: 404 Not Found

<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
  <reason>Unable to locate the specified code.</reason>
</result>

Example: Attempting to validate a code in a code class that doesn't exist

Summary

This demonstrates an unsuccessful attempt at validating a code for a code class that doesn't exist.

Response

HTTP Status Code: 404 Not Found

<?xml version="1.0" encoding="UTF-8"?>
<result ver="1.0">
  <reason>Unable to locate the specified code class.</reason>
</result>