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
{
  "requestId": "req-0414ff1c-5e7b-456a-8730-aa970bc8146b",
  "method": "GET",
  "status": 400,
  "code": "EC_PERSON_ID_HEADER_REQUIRED",
  "message": "The person id in missing in the header",
  "sysMessage": "personId_missing"
}

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)
StatusTextDescription
200OKEverything worked as expected
400Bad RequestThe request was unacceptable, often due to missing a required parameter
401UnauthorizedThe request was unauthorized, or had missing or invalid API key
403ForbiddenThe API key doesn’t have permissions to perform the request
404Not FoundThe requested resource doesn’t exist
409ConflictThe request conflicts with another request (perhaps using the same idempotency key).
429Too Many RequestsToo many requests hit the API too quickly (due to rate limiting)
500, 502, 503, 504Server ErrorsSomething went wrong on the platform

Here is a link to see the full list of error codes for the Solid platform: Solid Error Codes

MetadataRate Limiting