Standard Responses

Unsuccessful API requests will return standard responses which are detailed below

HTTP 400 - Bad Request

An HTTP 400 response indicates a problem with the parameters / data passed to the API.

Our responses will return an array of failures conforming to the following type definition

Code
 
interface ValidationFailure {
  /**
   * The parameter or property name
   */
  property?: string;
  /**
   * Details of the problem
   */
  message: string;
}

For example:

Code
 
[
  {
    "property": "email",
    "message": "Email address is not valid"
  }
]

HTTP 404 - Not Found

An HTTP 404 response indicates you're trying to access a resource that does not exist.

Not found responses will have the following structure

Code
 
interface ItemNotFoundError {
  /**
   * The entity type
   */
  type: string;
  /**
   * The requested object id
   */
  id: string
}

Example:

Code
 
{
  "type": "OrganisationUser",
  "id": "<uuid>"
}