Error responses

Error responses

This page describes the error structure used for the whole API.

If an endpoint extends this structure, it would be specified in its own documentation page.

   
HttpStatus status
RestError error        
   
String code
String name                                       
String description
ErrorType severity ERROR("ERROR"), WARNING("WARNING")
                              
String technicalDetails
String requestedURI

 

Examples

 

{
    "status": "OK",
    "restError": {
        "code": "business.100",
        "name": "List empty, Verify parameters",
        "severity": "WARNING"
    }
}

 

RestError example

  • "business.001", "season must not be empty",  ErrorType.WARNING  
  • "business.100", "List empty, Verify parameters", ErrorType.WARNING 
  • "business.101", "List empty, Verify parameters", ErrorType.WARNING 
  • "business.102", "List empty, Verify parameters", ErrorType.WARNING

Docs Navigation