The following is a list of messages generated by the XML Gateway APIs. The list is organized by API Return Code for easy reference. The list contains the following columns:
API Return Code
Message Code
Message
The API Return Code represents the status of the API. The calling program can interrogate the return code and provide an application-specific error handler to address the error detected. Because these messages are designed for communication between application APIs, the necessary corrective actions are addressed during the development process. There is no action required, unless you are developing a custom transaction.
| API Return Code | Description |
|---|---|
| 0 | Success |
| 1 | Warning |
| 2 | Unexpected Error |
| 3 | Null value detected for required parameter |
| 4 | Invalid parameter value |
| 5 | Cannot insert duplicate row |
| 6 | No data found for given parameter values |
| 7 | Duplicate row exists for given parameter values |
| 8 | Cannot delete due to referential integrity |
Because the focus of this section is on troubleshooting, API Return Code of 0 (Success) is excluded from the following list. As of this printing, there are no seeded messages with API Return Code of 1 or 2.
| API Return Code | Message Code | Message |
|---|---|---|
| 3 | ECX_CATEGORY_ID_NOT_NULL | Code category ID is a required parameter. |
| 3 | ECX_CODE_CATEGORY_NOT_NULL | Code category is a required parameter. |
| 3 | ECX_CONNECTION_TYPE_NOT_NULL | Connection type is a required parameter. |
| 3 | ECX_DATA_SEEDED_NOT_NULL | XRef data seeded is a required parameter. |
| 3 | ECX_DIRECTION_NOT_NULL | Direction is a required parameter. |
| 3 | ECX_EMAIL_ADDRESS_NOT_NULL | Email_address is a required parameter. |
| 3 | ECX_EXT_PROCESS_ID_NOT_NULL | External process ID is a required parameter. |
| 3 | ECX_HUB_USER_ID_NOT_NULL | Hub User ID is a required parameter. |
| 3 | ECX_LOCATION_NOT_NULL | Location Code is a required parameter. |
| 3 | ECX_MAP_CODE_NOT_NULL | Map Code is a required parameter. |
| 3 | ECX_PARTY_ID_NOT_NULL | Party ID is a required parameter. |
| 3 | ECX_PARTY_SITE_ID_NOT_NULL | Party Site ID is a required parameter. |
| 3 | ECX_PARTY_TYPE_NOT_NULL | Party Type is a required parameter. |
| 3 | ECX_PROTOCOL_TYPE_NOT_NULL | Protocol type is a required parameter. |
| 3 | ECX_PWD_NOT_NULL | For protocol type: &p_protocol_type, the password is a required parameter. |
| 3 | ECX_STANDARD_CODE_NOT_FOUND | Standard code: &p_standard_code not defined. |
| 3 | ECX_STANDARD_CODE_NULL | Standard Code is a required parameter. |
| 3 | ECX_STANDARD_NOT_NULL | Document standard is a required parameter. |
| 3 | ECX_TP_DTL_ID_NOT_NULL | Trading partner detail ID is a required parameter. |
| 3 | ECX_TP_HDR_ID_NOT_NULL | Trading partner header ID is a required parameter. |
| 3 | ECX_TRAN_SUBTYPE_NOT_NULL | Transaction Subtype is a required parameter. |
| 3 | ECX_TRANSACTION_SUBTYPE_NOT_NULL | Transaction type is a required parameter. |
| 3 | ECX_TRANSACTION_TYPE_NOT_NULL | Transaction type is a required parameter. |
| 3 | ECX_XREF_DTL_ID_NOT_NULL | XRef detail ID is a required parameter. |
| 3 | ECX_XREF_EXT_VAL_NOT_NULL | XRef external value is a required parameter. |
| 3 | ECX_XREF_INT_VAL_NOT_NULL | XRef internal value is a required parameter. |
| 3 | ECX_XREF_STANDARD_ID_NOT_NULL | XRef standard ID is a required parameter. |
| 3 | ECX_XREF_STD_VAL_NOT_NULL | XRef standard value is a required parameter. |
| 3 | ECX_USRNAME_NOT_NULL | For protocol type: &p_protocol_type, the username is a required parameter. |
| 4 | ECX_DATA_OWNER_INCONSISTENT | Data owner: &p_owner is inconsistent with data seeded flag: &p_data_seeded. |
| 4 | ECX_INVALID_CONF_CODE | Confirmation code: &p_confirmation is invalid. |
| 4 | ECX_INVALID_DIRECTION | Direction: &p_direction is invalid. |
| 4 | ECX_INVALID_EMAIL_ADDRESS | Email_address: &p_email_address is invalid. |
| 4 | ECX_INVALID_EXT_PROCESS_ID | External process ID: &p_ext_process_id is invalid. |
| 4 | ECX_INVALID_HUB_ID | Hub ID: &p_hub_id is invalid. |
| 4 | ECX_INVALID_HUB_USER_ID | Hub user ID: &p_hub_user_id is invalid. |
| 4 | ECX_INVALID_MAP_CODE | Map Code: &p_map_code is invalid. |
| 4 | ECX_INVALID_PARTY_ID | Party ID: &p_party_id is invalid. |
| 4 | ECX_INVALID_PARTY_SITE_ID | Party_site_id: &p_party_site_id is invalid. |
| 4 | ECX_INVALID_PARTY_TYPE | Party Type: &p_party_type is invalid. |
| 4 | ECX_INVALID_PROTOCOL_TYPE | Protocol type: &p_protocol_type is invalid. |
| 4 | ECX_INVALID_PWD | The password should not contain special characters. |
| 4 | ECX_INVALID_PWD_LEN | The length of the password should be greater than 5 characters. |
| 4 | ECX_INVALID_ROUTING_ID | Routing ID: &p_routing_id is invalid. |
| 4 | ECX_INVALID_TP_DETAIL_ID | Tp_detail_id: &p_tp_detail_id is invalid. |
| 4 | ECX_INVALID_TP_HDR_ID | Tp_header_id: &p_tp_header_id is invalid. |
| 5 | ECX_CODE_CATEGORY_EXISTS | Code category: &p_xref_category_code is already defined in the table. |
| 5 | ECX_DOCUMENT_STANDARD_EXISTS | Standard already exists with standard code &p_standard_code and standard type &p_standard_type. |
| 5 | ECX_DUPLICATE_TRANSACTIONS | Duplicate Rows found for Transaction Type: &p_transaction_type, Transaction Subtype: &p_transaction_subtype, and Party Type: &p_party_type. |
| 5 | ECX_TP_DTL_EXISTS | Trading Partner detail record for tp_header_id: &p_tp_header_id, ext_process_id: &p_ext_process_id is already defined in the table. |
| 5 | ECX_TP_DTL1_EXISTS | Trading Partner detail record for the combination of External Transaction Type: &p_ext_type, External Transaction Subtype: &p_ext_subtype, Document Standard ID: &p_standard_id, Source TP Location Code: &p_source_tp_location_code is already defined for the inbound transaction. |
| ECX_TP_DTL2_EXISTS | Trading Partner detail already exists for this combination of tp_header_id: &p_tp_header_id, Transaction Type: &p_transaction_type, Transaction Subtype: &p_transaction_subtype for outbound transactions. | |
| 5 | ECX_TP_HDR_EXISTS | Trading Partner for party_type: &p_party_type, party_id: &p_party_id, party_site_id: &p_party_site_id is already defined in the table. |
| 5 | ECX_XREF_DTL_ID_ROW_EXISTS | Duplicate code conversion record for header id: &p_tp_header_id, external value: &p_xref_ext_value, internal value: &p_xref_int_value, direction: &p_direction. |
| 5 | ECX_XREF_DTL_ROW_EXISTS | Duplicate code conversion record for code category: &p_xref_category_code, Standard code: &p_standard_code, external value: &p_xref_ext_value, internal value: &p_xref_int_value, direction: &p_direction. |
| 5 | ECX_XREF_STD_ID_ROW_EXISTS | Duplicate standard code conversion record for XRef standard ID: &p_xref_standard_id, Standard value: &p_xref_std_value, Internal value: &p_xref_int_value. |
| 5 | ECX_XREF_STD_ROW_EXISTS | Duplicate standard code conversion record for document standard: &p_standard, Standard value: &p_xref_std_value, Internal value: &p_xref_int_value. |
| 6 | ECX_CODE_CATEGORY_NOT_FOUND | Code category: &p_xref_category_code not defined. |
| 6 | ECX_HUB_NOT_EXISTS | No Hub definition exists for connection_type: &p_connection_type and protocol: &p_protocol_type. |
| 6 | ECX_NO_ROWS_DELETED | No rows deleted in table: &p_table, &p_param_name: &p_param_id is invalid. |
| 6 | ECX_NO_ROWS_UPDATED | No rows updated in table: &p_table, &p_param_name, &p_param_id is invalid. |
| 6 | ECX_NOT_FOUND | No rows fetched from table: &p_table and key: &p_key. |
| 6 | ECX_STANDARD_NOT_FOUND | Document standard: &p_standard not found. |
| 6 | ECX_STANDARD_ROW_NOT_FOUND | No standard found with standard code &p_standard_code and standard type &p_standard_type. |
| 6 | ECX_TP_DTL_NOT_FOUND | No trading partner detail records found for tp_header_id: &p_tp_header_id, ext_process_id: &p_ext_process_id. |
| 6 | ECX_TP_DTL1_NOT_FOUND | No trading partner detail records found for party_type: &p_party_type, party_id: &p_party_id, party_site_id: &p_party_site_id, transaction_type: &p_transaction_type, transaction_subtype: &p_transaction_subtype, standard code: &p_standard_code, direction. |
| 6 | ECX_TP_HDR_NOT_FOUND | No trading partner header records found for party type: &p_party_type, party_id: &p_party_id, party_site_id: &p_party_site_id. |
| 6 | ECX_TRANSACTION_NOT_FOUND | No Transaction defined for Transaction Type: &p_transaction_type, Transaction Subtype: &p_transaction_subtype, and Party Type: &p_party_type. |
| 6 | ECX_XREF_DTL_EXT_ID_NOT_FOUND | No code conversion detail records found for standard code: &p_standard_code, code category: &p_xref_category_code, tp header ID: &p_tp_header_id, external value: &p_xref_ext_value. |
| 6 | ECX_XREF_DTL_INT_ID_NOT_FOUND | No code conversion detail records found for standard code: &p_standard_code, code category: &p_xref_category_code, tp header ID: &p_tp_header_id, internal value: &p_xref_int_value. |
| 6 | ECX_XREF_DTL_NOT_FOUND | No code conversion detail records found for standard code: &p_standard_code, code category: &p_xref_category_code, direction: &p_direction, external_value: &p_xref_ext_value, internal value: &p_xref_int_value. |
| 7 | ECX_STANDARD_TOO_MANY_ROWS | More than one row exists for the unique key-standard code: &p_standard_code and standard type: &p_standard_type. |
| 7 | ECX_TOO_MANY_ROWS | More than one row fetched from table: &p_table and key: &p_key. |
| 7 | ECX_TP_DTL_TOO_MANY_ROWS | Number of records fetched is greater than one for tp_header_id: &p_tp_header_id, ext_process_id: &p_ext_process_id. |
| 7 | ECX_TP_DTL1_TOO_MANY_ROWS | Number of records fetched is greater than one for party_type: &p_party_type, party_id: &p_party_id, party_site_id: &p_party_site_id, transaction_type: &p_transaction_type, transaction_subtype: &p_transaction_subtype, standard_code: &p_standard_code, direction |
| 7 | ECX_TP_HDR_TOO_MANY_ROWS | Number of records fetched is greater than one for party_type: &p_party_type, party_id: &p_party_id, party_site_id: &p_party_site_id. |
| 7 | ECX_TRANS_TOO_MANY_ROWS | Too many rows in transactions for Transaction Type: &p_transaction_type, Transaction Subtype: &p_transaction_subtype, and Party Type: &p_party_type. |
| 7 | ECX_XREF_DTL_EXT_TOO_MANY_ROWS | Number of records fetched is greater than one for standard code: &p_standard_code, code category: &p_xref_category_code, tp header ID: &p_tp_header_id, external_value: &p_xref_ext_value. |
| 7 | ECX_XREF_DTL_INT_TOO_MANY_ROWS | Number of records fetched is greater than one for standard code: &p_standard_code, code category: &p_xref_category_code, tp header ID: &p_tp_header_id, internal value: &p_xref_int_value. |
| 8 | ECX_CODE_CATEGORY_REFERENCED | Unable to delete code category ID: &p_category_id because it is referenced in other tables. |