Error Management

In case of error, the server returns an apirequest_uuid field that it is important to include in your support requests.

Note

This error handling is common to eligibility, to the orders and services APIs and will be gradually deployed to other endpoints..

Error Formats

Field Name	Type	Description
apirequest_uuid	string	UUID identifier of the error
details	dict list or null	List of error details
error	string	Error message

Examples

HTTP/1.1 500 Internal server error
Content-Type: application/json

{
    "apirequest_uuid": "KOSC_fb3140c4-2305-4185-952d-2aa5c4c2e0f4",
    "details": null,
    "error": "Unable to serve your request"
}

HTTP/1.1 400 Bad request
Content-Type: application/json

{
   "apirequest_uuid": "KOSC_fb3140c4-2305-4185-952d-2aa5c4c2e0f4",
   "details": [
      {
         "field": "reference",
         "errors": ["This field is required."]
      }
   ],
   "error": "Invalid input"
}