Interpreting the results of API calls

Each API function returns a string consisting of a return code, a reason code, and message text. Use the information in the following sections to interpret the results of the API calls.

About this task

Use the information in this section to interpret the returned values of the variables rccret, rccrsn, and rccmsgtext.

  • rccret is the return code and returns the following values and meanings:
    • 0: Successful/normal completion of the function
    • 4: Warning (the function call completed successfully, but issued a warning message)
    • 8: Error (the function call completed unsuccessfully, possibly due to a missing or invalid parameter or the detection of an exception)
    • 12: Severe Error (the function call completed unsuccessfully, possibly because data sets required to perform the function could not be allocated)
  • rccrsn is the message ID and it is displayed in the format RCCx-nnn where x is the message severity level, and nnn is the message number. The following list provides the format and valid values of the message ID:
    • Message severity level can be any of the following types:
      • I (informational)
      • W (warning)
      • E (error)
      • S (severe error)
    • Message number is a unique three digit numeric field. For a list of valid message numbers, see TSO Client API Messages.
  • rccmsgtext is the message text.

Example

Here is an example of the return information you could receive after you write and issue an API call:

8 612 RCCE-612 Invalid RCCTSTC request. An invalid host argument, bad.host.name.com, was specified. Processing is terminated.

In this example, the return code is 8, the reason code is 612, the message number is RCCE-612, and the message text is Invalid RCCTSTC request. An invalid host argument, bad.host.name.com, was specified. Processing is terminated.