Error responses from JSON web services

If an error occurs during the execution of a JSON web services request, the HTTP status code is set to a value that indicates the type of error.

Details of the error are returned in a JSON object with the following format:
{
   "Fault":
   {
      "detail":
      {
         <additional detail fields> 
      },  
      "faultstring": "<Error text>" 
   } 
}
The detail object can contain the following fields:
  • Description: A description of the error suitable for display to users.
  • CICSServer: The CICS server that the web service request was sent to.
  • AbendCode: The abend code if an abend occurs in the CICS program that implements the web service.
  • ExceptionMessage: The exception message if an internal exception occurs within CICS TG.

A CICS program that uses the channel interface to implement a RESTful web service, can indicate its own error conditions by setting the HTTP status code in the DFHHTTPSTATUS container along with a custom error response. For more information, see Creating a RESTful JSON web service.