Response status codes
Each API request receives a response with a JSON payload and a standard HTTP status code. In any case other than a status code 200 (OK), the JSON payload provides additional detail regarding the error.
Code | Description |
|---|---|
200 (OK) | This code indicates a successful call and operation. The response payload is JSON, structured according to the nature of the request. |
204 (No content) | This code indicates a successful call and operation. There are no centroids for the model specified with the model=<num>. Models with zero centroids and unknown models both return this result. |
400 (Bad request) | This code indicates that there was a problem with the structure of the request or its payload. If the failure can be determined, the response payload identifies the failure in the request. A common cause of this type of error is malformed JSON in the request body or an incorrect URL parameter. |
401 (Unauthorized) | This code indicates that there was was a problem with the authentication. Either the request does not provide an authentication key, or the authentication key is malformed or not found. |
404 (Not found) | This code indicates that a request was made for a resource that does not exist. This most commonly occurs with an improperly formed request URL or an invalid API key. |
500 (Internal server error) | This is a catch-all code for any unhandled errors that have occurred on the server. If you encounter this error code, contact BlackBerry customer support. |
501 (Not implemented) | This code indicates that a request was made against a resource with an operation that has not been implemented yet. Such operations should be identified accordingly in this documentation. |
503 (Service unavailable) | This code indicates that the server is having issues completing the requests. The client should try again later. |