HTTP Response Codes
The OnPoint API applies HTTP Response Codes to every request.
| Response Code | Description |
|---|---|
| 200 OK | Success! |
| 400 Bad Request | The request was invalid. An accompanying error message will explain why. |
| 401 Unauthorized | API key was missing or incorrect. |
| 403 Forbidden | An accompanying error message will explain why. This code is used when requests are being denied due to rate limiting or permission restrictions. |
| 404 Not Found | The URI requested is invalid, the resource requested does not exist, or matching data could not be found. |
| 415 Unsupported Media Type | The requested response format is not allowed. |
| 500 Internal Server Error | Something is broken. Please notify support. |
| 502 Bad Gateway | The API is down or being upgraded. |
| 503 Service Unavailable | The API servers are up, but overloaded with requests. Try again later. |
The HTTP response codes can be suppressed by setting the _suppress_response_codes parameter to 1 on any resource URI. If set to 1, the HTTP response code will always be 200.
Error Messages
When the OnPoint API returns error messages, it attempts to do so in your requested format. For example, the error code from a JSON request may look like:
{
"response_code": "400",
"message": "A plain language description of the problem."
}
