CICS management client interface problem determination

The CICS management client interface provides return codes and several types of diagnostic information to help you determine the cause of errors.

If the CICS management client interface receives a request from the client that is not valid, the request fails and the API returns a non-OK code in the HTTP header of the response. The CICS management client interface does not process the request and provides no other information. See CICS management client interface error messages for a description of these response codes.

If the CICS management client interface determines that the request is valid, it returns an HTTP 200 OK response code and generates an EXEC CICS or an EXEC CPSM call. If this call encounters any errors, the API returns diagnostic information in the XML body of the response. This information takes the form of response and reason codes in the <resultsummary> element of the XML response, and in certain cases, feedback records that provide extra information.

The <resultsummary> element contains four attributes that you can use to determine the cause of a failure:
  • api_function
  • api_response1
  • api_response1_alt
  • api_response2
  • api_response2_alt
See <resultsummary> element for a description of these attributes.

If the CICS management client interface receives any exception conditions, it passes them to the client in the <errors> element of the XML response. The <errors> element is absent if the request completes successfully. The <errors> element contains one or more <feedback> elements each containing a FEEDBACK record. In the case of certain BAS errors, the <feedback> element contains an additional <installerror>, <inconsistentscope>, or <inconsistentset> element containing a BINSTERR, BINCONSC, or BINCONRS record respectively.