Responses

All API calls will return a standard HTTP response code as indicated below. Response payload examples are indicated below, however each API endpoint should indicate the actual structure of the response payload.

Success

HTTP Code: 200

Example Response

    {
        "status": "success",
        "request_id": "<request id>"
    }

Success No Content

HTTP Code: 204

Note

No response payload will be provided

Bad Request

HTTP Code: 400

Example Response

{
    "status": "invalid payload",
    "reason": {
        "items": [
            "Unknown LucidID(s)."
        ]
    }
}

Unauthorized

HTTP Code: 401

Note

No response payload will be provided

Invalid Payload

HTTP Code: 403

• reason should contain one or more errors with the submitted data

Example Response

{
    "status": "invalid payload",
    "reason": {
        "items": [
            "Unknown LucidID(s)."
        ]
    }
}

Method Not Allowed

HTTP Code: 405

Example Response

{ “detail”: “Method “PUT” not allowed.” }

Application Error

HTTP Codes: 500, 502, 503, 504

Note

No response payload will be provided