HTTPS Responses

All errors are returned as http 1.1 status codes. The common codes used by the APIs are:

  • 200 OK: Success

  • 201 Created: The requested item was created.

  • 202 Accepted: The request was accepted. Generally, a URL is provided to obtain additional details, for example, for polling the OAuth status.

  • 302 Found: The requested resource resides temporarily under a different URI.

  • 400 Bad Request: The request is invalid. Information returned in the ApiErrors message (the example below) shows more details.

  • 401 Unauthorized: The authentication credentials were not supplied or were incorrect.

  • 403 Forbidden: The operation is forbidden.

  • 404 Not Found: The URI requested does not exist on the server.

  • 405 Method Not Allowed: The method specified in the request line is not allowed for the resource identified by the Request-URI.

  • 408 Request Timeout: The client did not produce a request within the time that the server was prepared to wait.

  • 500 Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request.

  • 501 Not Implemented: The server does not have the functionality to fulfill the request identified by the Request-URI.

  • 503 Service Unavailable Error: The requested operation is unavailable at this time.

Field-specific errors and database errors are provided in an XML error message with the format: 


<ApiErrors>
	<ApiError>
		<ErrorType>Type of Error</ErrorType>
		<ErrorData>Field Error Occurred</ErrorData>
		<ErrorMessage>A Description of the Error</ErrorMessage>
	</ApiError>
</ApiErrors>