Errors

The Umetrics® Studio API makes use of conventional HTTP response codes to indicate the success or failure of a request. In general:

Codes in the 2xx range indicate success.
Codes in the 4xx range indicate that a request made by the client was invalid.
Codes in the 5xx range indicate an error on the server side.

Upon encountering an error, the response includes not only the HTTP status code but also a descriptive body that outlines the specifics of the error, reasons behind it, and steps to remedy the situation. Below is a sample response for situations where an access token is missing from the request:

{
  "error": {
    "code": "missing_token",
    "url": "https://umetrics.studio/docs-api/errors/#missing_token",
    "title": "Missing Access Token",
    "detail": "Access token must be included with the request."
  }
}

The structure of the error response is consistent across different types of errors. It contains the error code, a URL pointing to the error's documentation, a user-friendly title describing the error, and a detailed explanation of why the error occurred, along with advice on how to correct it. A comprehensive list of all possible error codes can be found in the documentation below.

Error codes

Below, you can find a list of potential error codes accompanied by instructions on how to troubleshoot and resolve them.

`invalid_api_version`

Incorrect or no longer supported API version was provided in the Sartorius-Studio-Api-Version header. This error also occurs when more than one Sartorius-Studio-Api-Version header is provided. Make sure that you use only one, supported version of the API.

`invalid_resource_id`

Invalid Resource ID was provided in a request. Make sure that the token is valid and that it didn't expire.

`invalid_token`

Invalid Access Token was provided in a request. Make sure that the token is valid and that it didn't expire.

`invalid_url`

Incorrect URL was provided in a request. Make sure that the endpoint you're trying to reach is valid.

`missing_token`

Request without Access Token was sent. Make sure the access token is present in the request.

`resource_unavailable`

The requested resource either does not exist, or you do not have access to it. The resource might not have been shared with you, or you may not have the sufficient licenses required to access it.

`service_unavailable`

Service is temporary unavailable. If this keeps happening, please contact us.

`service_error`

An error occurred. If this keeps happening, please contact us.