C API Status and Error Codes



Status codes

Every API call returns a status code. The following table lists status codes that could result from an API call. Use the following table to identify status codes.

Defined Name Value Error Description
SAI_OK 0 No error
SAI_ERROR 1 General error in the C API
SAI_SQL_ERROR 2 An SQL error occurred
SAI_CLIENT_ERROR 3 An error occurred while the API was attempting to communicate with the application server.

Note: When making an API call it is recommended that you check the status code against SAI_OK.


Error codes

The following error codes are valid when the status code resulting from an API call is SAI_ERROR. For a list of SAI_SQL_ERROR codes, refer to your database manual. Also, SAI_CLIENT_ERROR codes can be referenced in the Tivoli SA-Script Language Reference.

Defined Name Value Error Description
SAI_WRONG_RESPONSE 4 The server responded with the wrong message.
SAI_INVALID_RECORDS 5 One or more of the records returned is incorrectly formatted.
SAI_CONNECTION_FAILED 6 The connection to the application server was unsuccessful.
SAI_INVALID_AppServer 7 The host name and port for the application server are invalid.
SAI_SUBMISSION_FAILURE 8 The application server did not correctly log the problem record.
SAI_INVALID_PARAMETER 9 One or more message parameters are incorrect.
SAI_NO_DATA 10 No data was returned from the application server action.
SAI_INVALID_SCIM 11 The specified SCIM does not exist.
SAI_CHECKSUM_FAILURE 12 A non-initialized submission structure was passed to an API call.