HTTP Response Codes & Errors |
| The Accompa API attempts to return appropriate HTTP status codes for every request. |
| |
HTTP Status Codes |
| Here are the most common HTTP status codes returned by the Accompa API. |
| |
- 200 OK: Success! API request processed and appropriate response sent successfully.
- 201 Created: New resource created successfully.
- 400 Bad Request: The request is invalid, or has bad syntax. An accompanying error message will explain reasons, if available.
- 401 Not Authorized: Authentication credentials were missing or incorrect.
- 403 Forbidden: The request is understood, but it has been refused. An accompanying error message will explain why.
- 404 Not Found: The URI requested is invalid or the resource requested, such as a requirement, does not exist.
- 409 Conflict: The request could not be completed due to a conflict with the current state of the resource. For example, you cannot delete a resource that has been already deleted.
- 415 Unsupported Media Type: The XML data sent via API request doesn't have proper format.
- 500 Internal Server Error: Server did not understand your request. Could be caused by incorrect syntax.
- 503 Service Unavailable: The Accompa servers are up - but you've exceeded either your daily limit or concurrent rate limit. Try again later. An accompanying error message will explain why, and when to retry.
|
| |
Error Messages |
When the Accompa API returns error messages, it includes them in XML format as shown below: |
| |
| ERROR RESPONSE |
<error>
<message>...</message>
...
</error> |
| The error message XML will contain a <message> child element with information about the error. In certain cases, there will be other child elements that provide additional information about the error. |
