SOAP API common exceptions

The Unica Campaign SOAP API may throw the following common exceptions. All exception localized messages are in the requested locale if available to Unica Campaign. The usual Java™ locale fallback policies apply.

RemoteException

This item applies only to the SOAP interface.

All SOAP calls to the API may throw a RemoteException if a system-level error is encountered, such as a problem in the SOAP envelope processing layer (Axis), a constraint that is defined in the web service WSDL was violated for some reason.

Run-of-the-mill checked and unchecked API exceptions, such as DataException, are returned as an error status, not as a RemoteException.

Refer to the SOAP interface section for details.

AuthenticationException

The user could not be authenticated for the specified Unica Campaign partition. Check the user role that is defined in Unica Platform.

Authorization Exception

The user is not authorized to perform the requested operation. This exception can be thrown by any API method, so it is undeclared (unchecked). Check the permissions that are assigned to the user role in Unica Platform.

Data Exception

A fatal exception occurred in the underlying database layer in Unica Campaign (unchecked).

Check the Unica Campaign flowchart and listener logs for details.

Lock Exception

A temporary exception that is thrown when the client attempts to update a component, such as a flowchart, while it is being edited by another user. Generally, this exception can be recovered from by waiting and then retrying the operation. Retry logic is the responsibility of the client.

InvalidComponentException

An attempt was made to reference an invalid or unknown component (campaign, flowchart, target cell). The exception's getComponentReference() method returns the offending component's reference.

InvalidAttributeException

An exception that is thrown when the client provides or references an invalid attribute, such as if it uses the wrong data type, or uses an array of values where none are allowed. The exception's getAttributeName() method returns the name of the problem attribute, getAttributeValue() returns the value, and getComponentReference() identifies the component (or bulk index).

AttributeExistsException

Thrown when the client tries to define a duplicate attribute metadata for a component. The exception's getAttributeName() method returns the name of the duplicate attribute; getComponentReference() identifies the component (or bulk index).

AttributeNotFoundException

Thrown whenever the client attempts to reference an unknown attribute (campaign, flowchart, target cell, etc.). The exception's getAttributeName() method returns the name of the unmatched attribute; getComponentReference() identifies the component (or bulk index).

CompositeException

A CompositeException is used by some APIs to report multiple errors back to the caller. It typically has more than one cause bound to it; all causes are captured as a list in the order that they occurred. The exception's getCauseList() method returns this list, which can be inspected further to get details of each error.

Note: Generally the API either completes successfully or rolls back its work before throwing a composite exception. See, for example, the bulk Target Cell Spreadsheet APIs described in SOAP API methods: Target cells.