Errors

Solid uses conventional HTTP response codes to indicate the success or failure.
Errors
 last updated: 
December 29, 2021

When there is an error, the Solid Platform returns an object with the details of the error. It includes the request Id, the method used, error status, code, external message, and an internal system message.

EXAMPLE

  1. {
  2.   "requestId": "req-0414ff1c-5e7b-456a-8730-aa970bc8146b",
  3.   "method": "GET",
  4.   "status": 400,
  5.   "code": "EC_PERSON_ID_HEADER_REQUIRED",
  6.   "message": "The person id in missing in the header",
  7.   "sysMessage": "personId_missing"
  8. }

In general:
- Codes in the 2xx range indicate success.
- Codes in the 4xx range indicate an error that failed given the information provided
- Codes in the 5xx range indicate an error with Solid's servers (let us know via a help desk ticket if you see them)

Status Text Description
200 OK Everything worked as expected
400 Bad Request The request was unacceptable, often due to missing a required parameter
401 Bad Request The request was unacceptable, often due to missing a required parameter
403 Forbidden The API key doesn't have permissions to perform the request
404 Not Found The requested resource doesn't exist
409 Conflict The request conflicts with another request (perhaps using the same idempotency key).
429 Too Many Requests Too many requests hit the API too quickly (due to rate limiting)
500, 502, 503, 504 Server Errors Something went wrong on the platform