Getting Started

Error Management

Overview

This article provides information on the types of errors and error structure.

Successful API calls to Fynapse will trigger a response with HTTP status code 2xx.

If an API call to Fynapse is unsuccessful, an error will be thrown and you will receive a response with a status other than 200. The response will comprise of one of the possible error codes listed below and an error message.

Error Codes

Status CodeCategoryDescription
400Validation ErrorOne or more of the validated fields contain invalid data
401Authentication ErrorThe authentication token has timed out or is unavailable
403Authorization ErrorThe given action is outside the scope of the permissions granted to the user in Fynapse
404Query ErrorThe provided resource ID (e.g. group ID or user ID) does not exist
5xxSystem ErrorFatal system errors that require contacting Aptitude Software Support with the error status and reference

Error Object

Example of an error:

1{
2"type": "com.aptitudesoftware.JsonParsingError",
3"title": "JSON parsing error",
4"detail": "JSON parsing failed, incorrect structure or schema",
5"timestamp": "2024-06-06T15:44:25.0965526",
6"reference": "c6062e85-934c-41f1-9763-602c1b0a3a16",
7"status": 400,
8"instance": "/api/v1/roles/search"
9}

Properties

type
string

Type of the error message

title
string

Title of the error message

detail
string

Details of the error message

timestamp
string

Timestamp when the error was thrown

reference
string

ID of the error

status
string

Status of the error

instance
string

The path component of a URI, if defined, only contains the slash character (’/’), the commercial-at character (’@’), and characters in the unreserved, punct, escaped, and other categories.

See API Reference for further details