Errors

The eeds API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with eeds's servers.

Status codes

Here is a list of the different categories of status codes returned by the eeds API. Use these to understand if a request was successful.

Name
2xx
Type
Description
A 2xx status code indicates a successful response.
Name
4xx
Type
Description
A 4xx status code indicates a client error.
Name
5xx
Type
Description
A 5xx status code indicates a server error.

Error responses

Whenever a request is unsuccessful, the eeds API will return an error response with an error type and message. Some errors will also include additional information containing details about the specific problem. You can use this information to understand better what has gone wrong and how to fix it.

For example, if you attempt to authenticate without submitting the required password parameter, you would receive the following error response:

Example error response

{
  "statusCode": 400,
  "message": "One or more errors occured!",
  "errors": {
    "password": [
      "Invalid password."
    ]
  }
}