API specification

Formats

The API returns HAL+JSON at the moment (see the HAL specification).

HAL+JSON

Responses have a _links attribute containing links to help in the navigation (e.g. when results need pagination).

Each individual entity has a self attribute in _links that represents the path to itself.

It is highly recommended for clients to use these links (Relations) to navigate between resources.

CORS

We use CORS (Cross-origin resource sharing). JSONP is not available (causes problem e.g. no custom header).

Errors

Error messages are provided as JSON, the key description gives a technical error message. In addition to the message, you should check the HTTP response code which will give you an idea of the problem (4xx vs. 5xx...).