ErrorResponses

A variety of errors can be returned by various requests. Errors are returned using the appropriate HTTP status code and the body of response contains additional details (an error response XML message).

HTTP Status Codes

Responses use the following standard HTTP status codes to indicate success or failure:

The following codes are defined:

Status Code	Name	Purpose
200	OK	The request was processed successfully and the response body contains the requested resource.
404	Not found	The requested resource was not found (e.g. an issue or attachment).
400	Bad request	The HTTP method used to access the resource (GET, HEAD, POST, etc) is not valid for the specified resource, one or more query string parameters are invalid, or the issue create/update failed.
403	Forbidden	The authorization details provided are invalid.
500	Internal server error	An unexpected error was encountered while processing the request.

Error Response XML Messages

Error responses use the following XML format:

XML

Copy

<?xml version=\"1.0\" encoding=\"utf-8\"?> 
<Error>   
  <Code></Code>   
  <Message></Message> 
</Error>

The following codes are defined:

Code	Message	Purpose
InvalidMethod	Specified method (GET, PUT, HEAD, DELETE, etc.) is invalid.	The HTTP method used to request the resource, eg. IssueDetails.ashx, is not a supported method.
InvalidAuthentication	Authentication details are invalid.	Authentication can fail for a variety of reasons. For security purposes a more specific error is not returned. The most common reason for authentication failures is either the access key/secret key are incorrect or the API has been disabled in the application.
InvalidProjectId	Specified ProjectId parameter is invalid (must be a valid integer).	Basic data type validation.
InvalidIssueId	Specified IssueId parameter is invalid (must be a valid integer).	Basic data type validation.
InvalidAttachmentId	Specified AttachmentId parameter is invalid (must be a valid integer).	Basic data type validation.
InvalidFilter	Filter parameter is invalid (not specified or empty).	A non-empty filter parameter must be specified.
InvalidCriteria	Criteria parameter is invalid (not specified or empty).	A non-empty search criterion must be specified.
CriteriaToLong	Criteria parameter is to long (cannot contain more than 50 characters).	The length of the criteria cannot exceed 50 characters.
IssueNotFound	Matching issue was not found.	This message is returned as response body and the status code is 404.
AttachmentNotFound	Matching attachment was not found.	This message is returned as response body and the status code is 404.
UnknownField	Unknown field specified: X	The specified field, X, is unknown (all fields must be defined in RMTrack).
IssueCreateOrUpdateFailed	Issue create or update failed: X	The specific reason why the issue create or update failed is provided.
InvalidParameterValue	The parameter X contains an invalid parameter, valid values are Y	The specified parameter must exactly match one entry in the list of valid values.
InternalError	... stack trace ...	This error occurs when an unexpected error is encountered. Please forward the error message details to your RMTrack support representative. The error message contains important information that will help the RMTrack support team determine the underlying cause of the problem.