Page Comparison

HTTP status code

Description

200

SUCCESS

The API call was successful and includes a json formatted result according to the API documentation.

204

SUCCESS

The API call was successful. The method does not return any results.

400

FAILED

The API call failed. The http call returns a json which describes the error. The json document has these properties:

{

"message": A user friendly and (generally) localized error message. Designed to be readable by end users. It is recommended to show these errors to the end user (if applicable).

"id": Some errors include an error identifier. Where used, ids are described with the API methods:

• BUSY: Returned when connecting and automatic operations are running so that a login is not possible. Try login again in a few seconds.
• LOGGEDOUT: You are not connected or had been disconnected.
• Other codes are explained in API method documentation where applicable.

"For example the ID may help your code to decide how to react to errors. See Error IDs for a complete list.

failed": Always set to "true".

}

Other codes

FAILED

There may be other http error codes returned. Other error codes that do not return a json object are low level errors likely due to the web server configuration and not the Beebox API itself. For example, a 404 error points to an inexistent API method.