Error response test

From ePrize Developers Wiki

Revision as of 19:54, 17 March 2009 (edit) Brian-quail (Talk | contribs) (New page: API Home Page :: API Debugging) ← Previous diff		Current revision (17:29, 8 April 2011) (edit) (undo) Wikiadmin (Talk | contribs)
Line 1:		Line 1:
-	[[API Home Page]] :: [[API Debugging]]	+	{{RESTfulAPI
		+	|crumbs=[[API Home Page]] :: [[API Debugging]]
		+	|summary=Output an error response. This can be used for testing error handling in your application.
		+	|resource=/v1/{apikey}/test/communication
		+	|methods=PUT
		+	|resourceargs='''apikey''': Your [[API Key]]
		+	|paramsrequired=None
		+	}}
		+
		+	{{RESTfulExample
		+	|title=Communication Test (PUT), will respond with an error
		+	|request=Request representation: empty
		+	|responsecode=404 Not Found
		+	|response=<?xml version="1.0" encoding="UTF-8" ?>
		+	<error ver="1.1" status_code="404">
		+	<message>Unknown resource</message>
		+	</error>
		+	}}

---

Current revision

API Home Page :: API Debugging

Summary

Output an error response. This can be used for testing error handling in your application.

Resource

/v1/{apikey}/test/communication

Valid Methods

PUT

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key

Parameters Required

None

Example: Communication Test (PUT), will respond with an error

Request

Request representation: empty

Response

HTTP Status Code: 404 Not Found

<?xml version="1.0" encoding="UTF-8" ?>
<error ver="1.1" status_code="404">
  <message>Unknown resource</message>
</error>