Error Handling

This section describes the various error code responses you might see when making an API call. If there is a problem serving your request, you will receive a response with an HTTP error code, and an XML response document.

HTTP Status Codes

Status Code Description
200 OK
400 Bad Request. The parameters passed to the service were invalid or not well-formed. The message in the XML document will provide more information.
401 Not Authorized. The user name or password submitted was not valid, or you do not have permissions to access this resource.
403 Forbidden. You do not have permissions to access this resource. This happens for services that require a valid client code, or when attempting accessing private projects or groups of which you are not a member.
503 Service Unavailable. An internal problem prevented us form returning data to you.

XML Body

For each error, you will receive an XML response having the format below. NOTE: The user-facing application should not display the verbose message; however, it should log that for diagnostic purposes.

	<?xml version="1.0" ?>
	<error>
		<code>403</code>
		<message>The error message</message>
		<verbose>More details - do not show to end-user, but do log it.</verbose>
	</error>