Common Function Return Values
Most methods return an enum value of type RUIResult. This is used to show whether the method call was accepted and executed successfully.
OK(0)
Function (which may be synchronous or asynchronous), fully successful during synchronous functionality.
SDK_INTERNAL_ERROR_FATAL(-999)
Irrecoverable internal fatal error. No further API calls should be made.
SDK_ABORTED(-998)
A required New Registration has failed, and hence the SDK is aborted. stopSDK() is possible.
INVALID_PARAMETER_EXPECTED_NON_NULL(-110)
Some API parameter is expected to be non-NULL, and is not.
INVALID_PARAMETER_EXPECTED_NON_EMPTY(-111)
Some API parameter is expected to be non-empty, and is not.
INVALID_PARAMETER_EXPECTED_NO_WHITESPACE(-113)
Some API parameter is expected to be free of white space, and is not.
INVALID_PARAMETER_TOO_LONG(-114)
Some API parameter violates its allowable maximum length.
INVALID_CONFIG_PATH(-120)
The configFilePath is not a well-formed directory name.
INVALID_CONFIG_PATH_NONEXISTENT_DIR(-121)
The configFilePath identifies a directory that does not exist.
INVALID_CONFIG_PATH_NOT_WRITABLE(-122)
The configFilePath identifies a directory that is not writable.
INVALID_PRODUCT_ID(-130)
The productID is not a well-formed Product ID.
INVALID_SERVER_URL(-140)
The serverURL is not a well-formed.
URL.INVALID_PROTOCOL (-144)
The protocol is not a legal value. Must be one of the following:
|
Protocol |
Description |
|
HTTP_PLUS_ENCRYPTION (1) |
Protocol to the Server is HTTP + AES-128 Encrypted payload. |
|
HTTPS_WITH_FALLBACK (2) |
Protocol to the Server is HTTPS, unless that doesn't work, falling back to HTTP + Encryption. |
|
HTTPS (3) |
Protocol to the Server is HTTPS with no fall-back. |
INVALID_AES_KEY_EXPECTED_EMPTY(-145)
The AES Key is expected to be NULL/empty, and it is not. This occurs if https is used at the protocol selection and an AES Key is supplied.
INVALID_AES_KEY_LENGTH(-146)
The AES Key is not the expected length (32 hex chars). An AES key is required if using HTTP_PLUS_ENCRYPTION or HTTPS_WITH_FALLBACK as the protocol choice.
INVALID_AES_KEY_FORMAT(-147)
The AES Key is not valid hex encoding. String passed must only include hexadecimal characters.
INVALID_SESSION_ID_EXPECTED_EMPTY(-150)
The sessionID is expected to be empty, and it was not. This occurs if a session ID is passed to functions that accept a session ID but no startSession() is active.
INVALID_SESSION_ID_EXPECTED_NON_EMPTY(-151)
The sessionID is expected to be non-empty, and it was empty.
INVALID_SESSION_ID_TOO_SHORT(-152)
The sessionID violates its allowable minimum length. Minimum length is 10.
INVALID_SESSION_ID_TOO_LONG(-153)
The sessionID violates its allowable maximum length. Maximum length is 64.
INVALID_SESSION_ID_ALREADY_ACTIVE(-154)
The sessionID is already currently in use.
INVALID_SESSION_ID_NOT_ACTIVE(-155)
The sessionID is not currently in use.
INVALID_CUSTOM_PROPERTY_ID(-160)
The customPropertyID violates its allowable range. By default the range is 1 to 20.
INVALID_DO_SYNC_VALUE(-170)
The doSync manual sync flag/limit violates its allowable range.
INVALID_MESSAGE_TYPE(-180)
The messageType is not an allowable value.
INVALID_LICENSE_DATA_VALUE(-185)
The license data is not an allowable value.
INVALID_PROXY_CREDENTIALS(-190)
The proxy username and password failed proxy authentication.
INVALID_PROXY_PORT(-191)
The proxy port was not valid.
CONFIG_NOT_CREATED (-200)
Configuration has not been successfully created. The function createConfig() must be called before performing this operation.
CONFIG_ALREADY_CREATED (-201)
Configuration has already been successfully created. A previous createConfig() was successful and the subsequent calls to this function are not allowed.
SDK_NOT_STARTED (-210)
SDK has not been successfully started. The function startSDK() must be called before using this function.
SDK_ALREADY_STARTED (-211)
SDK has already been successfully started. A previous startSDK() was successful and subsequent calls to this function are not allowed.
SDK_ALREADY_STOPPED (-213)
SDK has already been successfully stopped. A previous stopSDK() was successful and subsequent calls to this function are not allowed.
FUNCTION_NOT_AVAIL (-300)
This indicates that this particular API call is not currently available. Possible causes include:
| • | This feature is disabled from the server side. If this is an optional feature you might need to turn it on from the Usage Intelligence dashboard. |
| • | You have called this function too many times in quick succession from the same client. In order to prevent abuse the server might impose a minimum interval (time threshold) before you can call this function again. This interval can vary from seconds to minutes. |
| • | There has been a time out on this request to the Usage Intelligence server. |
SYNC_ALREADY_RUNNING (-310)
A sync with the Server is already running. Only one sync operation may be running at a time.
TIME_THRESHOLD_NOT_REACHED (-320)
The API call time frequency threshold (set by the Server) has not been reached. In other words, the application is generating too many requests per time period.
SDK_SUSPENDED (-330)
The Server has instructed a temporary back-off. No events are logged but future communication with the Server is possible if the server allows it.
SDK_PERMANENTLY_DISABLED (-331)
The Server has instructed a permanent disable. No communication with the server is possible and events will not be logged.
SDK_OPTED_OUT (-332)
Instance has been instructed by the application to opt-out.
NETWORK_CONNECTION_ERROR (-400)
Communication attempts were not able to reach the Server. This means there was a problem communicating with the Usage Intelligence server due to:
| • | Network connectivity problems |
| • | Incorrect proxy settings |
| • | HTTP or HTTPS traffic is blocked by a gateway or firewall |
In some cases, you can use testConnection() to help diagnose the issue.
NETWORK_SERVER_ERROR (-401)
Error while communicating with the Server. Communication with the server was successful but the server response indicates a Server error.
Login to the Usage Intelligence dashboard to make sure your account is active and there are no critical warnings. Test using testConnection() function.
NETWORK_RESPONSE_INVALID (-402)
The response from the Server was returned with a message format error.
TEST_CONNECTION_INVALID_PRODUCT_ID (-420)
The testConnection() function had an invalid ProductID supplied. Check the Product ID provided to you for accuracy.
TEST_CONNECTION_MISMATCH (-421)
The testConnection() function had a mismatch between URL and Product ID. Check the Product ID and URL provided to you for accuracy.