Previous Topic: API Return Code DefinitionsNext Topic: Metamodel Diagrams


API Return Codes

The following table lists and defines the API Return Codes:

API Return Code

Return Code Definition

EAPI_ASSOC_NOT_FOUND_RC

association occurrence not found

EAPI_ATC_INVALID_RC

association type code is invalid

EAPI_AUTH_NOT_FOUND_RC

user/group not authorized for model or subset

EAPI_CHECKOUT_NOT_FOUND_RC

checkout not found

EAPI_CONNECT_FAILED_RC

connection not successful

EAPI_DEST_OBJ_NOT_FOUND_RC

destination object not found

EAPI_GROUP_NOT_FOUND_RC

group not found

EAPI_LOCK_NOT_FOUND_RC

lock not found

EAPI_MAXIMUM_COUNT_REACHED_RC

successful and if the number found is greater than the number input. This indicates the function call is successful but that the maximum count has been reached.

EAPI_MNEMONIC_INVALID_RC

mnemonic is invalid

EAPI_MODEL_ALREADY_LOCKED_RC

model already locked

EAPI_MODEL_NOT_CHECKED_OUT_RC

model not checked out

EAPI_MODEL_NOT_FOUND_RC

model not found

EAPI_MODEL_PARENT_NOT_FOUND_RC

model has no parent

EAPI_NOT_CONNECTED_RC

not connected to encyclopedia

EAPI_OBJECT_NOT_FOUND_RC

object not found

EAPI_OBJECT_NOT_IN_SUBSET

object not defined in subset

EAPI_OTC_INVALID_RC

object type code is invalid

EAPI_PTC_INVALID_RC

property type code is invalid

EAPI_SOURCE_OBJ_NOT_FOUND_RC

source object not found

EAPI_SUBSET_NOT_CHECKED_OUT_RC

subset not checked out

EAPI_SUBSET_NOT_FOUND_RC

subset not found

EAPI_SUCCESSFUL_RC

the Encyclopedia API Function Call was successful

EAPI_USER_NOT_FOUND_RC

user or group not found

EAPI_USER_NOT_LOGGED_ON_RC

user not logged on

EAPI_MODEL_LOCKED_RC

a model is in use

EAPI_MODEL_INCOMPATIBLE_RC

the model schema is incompatible

EAPI_MODEL_FATAL_ERROR_RC

a fatal error occurred while opening a workstation model

EAPI_MODEL_DIR_READ

the model directory cannot be read when opening a workstation model

EAPI_MODEL_BAD_ERRFILE_RC

the input error file cannot be opened when opening a workstation model

EAPI_INVALID_DIR_PASSWORD_RC

The password given is not the password on file for the given user Id

EAPI_DIRUSER_NOT_FOUND_RC

The userid entered is not present on On the file .

EAPI_PASSWORD_DECRYPTION_FAILED_RC

The decryption of the Password has failed when trying to compare the existing password in file with the password given.

EAPI_DIRUSER_NOT_ACTIVE_RC

The user entered is not an active user

EAPI_SUCCESSFUL_RC

The password given is the password on file for the given user Id

EAPI_FUNCTION_FAULT_RC

Some fault occurred and the validity of the password could not be determined. The fault can be either the clients are Not started or the failure of validation of arguments