Possible API status responses

A regular http status 200 response for single content:

{
  "_data": {...},
  "_meta": {
    "version": "1.11.44"
  },
  "_status": {
    "message": "OK",
    "transactionId": "dd51afbf-7e94-4b44-802e-d23cb4b24e93",
    "code": 200,
    "success": true
  }
}

A regular http status 200 for an array:

{
  "_data": [{...}, {...}],
  "_page": {
    "offset": 0,
    "limit": 5,
    "count": 5,
    "total": 10
  },
  "_meta": {
    "version": "1.11.44"
  },
  "_status": {
    "message": "OK",
    "transactionId": "dd51afbf-7e94-4b44-802e-d23cb4b24e93",
    "code": 200,
    "success": true
  }
}

The data prop will return an array or object depending on your request. If the respons is an array you also receive a _page prop that can be used for pagination. The _status property provides an overview of the outcome of the request.

Possible error responses

{
  "_meta": {
    "version": "1.11.44"
  },
  "_status": {
    "transactionId": "dd51afbf-7e94-4b44-802e-d23cb4b24e93",
    "error": "Unprocessable Entity",
    "message": "Validation Failed due to value field. Offset can not be above 10000",
    "success": false,
    "status": 422
  }
}

In the example above, the request returns an error. The _status prop returns some practical information on why you received this error, including a corresponding http error response code.

The transactionId is our internal id for this request. This is also used for debugging by our development team. If you encounter an unknown error and report it to our team, the transactionId for your request will help us identify and solve your issue faster.

http 202

The data object has been accepted, but the full content is not yet ready for you. This could happen if you request an item immediately after it has been submitted

http 422

The data provided is not valid data. I.e. you provided string not an integer, or you missed a required field

http 403

This response means that either you do not have access to the item you requested, or that you do not have access to perform a search with a given facet in your request

http 404

This is not the droids you are looking for

http 410

The requested item have been marked as deleted

http 500

This should of course not happen. If recurring, please provide us the transactionId and we’ll investigate