To use the M-Business SOAP API, the SOAP client must first successfully call loginUser().The SOAP client must then retrieve the sessionId in the response header and send it with all subsequent function calls. Refer to the Java and C# samples we ship to see how to do this. For an overview, see SOAP Sample Client Files.

Permissions

All functions are available to the built-in admin user. A regular user may call a subset of these functions. If you see a permission denied error, you must be admin to call that function.

Error messages

Each SOAP client must use the mechanism in its SOAP client library to handle the response from each function call. If using SOAP over HTTP, a 200 response from the M-Business SOAP Server indicates the function succeeded. If not, a SOAP-formatted error message is returned. 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 the agsoap.conf file for more information.

Pseudocode

Because you call a SOAP function in very different ways from each language, the reference material in this document provides pseudocode instead of a synopsis.