M-Business SOAP API error messages

Each SOAP client must use the mechanism in its SOAP client library to handle the response from each function call. If you use SOAP over HTTP, a 200 response from the SOAP server indicates the function succeeded. If not, a SOAP-formatted error message is returned (M-Business SOAP API error messages). Your SOAP client should trap and act on these. When developing, the M-Business SOAP Server has several options for logging SOAP messages. Refer to agsoap.conf for more information.

Use the Faultstring parameter when a SOAP function returns a formatted error message to determine the cause of the error. First, convert the Faultstring to lowercase text, then compare it to the following list of error messages.

Table 1. SOAP error message Faultstring contents

If Faultstring parameter contains:

Error is:

ag_firstname_too_long

The user's first name is too long.

ag_group_exists

The group name you are trying to create already exists.

ag_lastname_too_long

The user's last name is too long.

ag_license_error

There was a licensing problem. Most likely you are trying to add a user beyond your licensed number of users.

ag_password_too_long

The user's password is too long.

ag_user_exists

The user name you are trying to create already exists.

ag_user_old_password_mismatch

The user’s old password has not been matched when attempting to change the user’s password.

ag_username_too_long

The username is too long.

agp_category_exists

The public channel category name you are trying to create already exists.

agp_xmldb_exists

The XML database name you are trying to create already exists.

java.net.ConnectException

The M-Business SOAP Server might not be running, or you may be trying to connect to the wrong host name or port.

Note: You only see this error if you are using a Java SOAP client,

verify and session

The current session has expired, you have to call loginUser again.