Login SOAP API
The login
API method can be used to establish a connection to ServiceOptimizer.
Description
All programs using the ServiceOptimizer SOAP APIs operate in a client process that is protected from any other ServiceOptimizer processes.
In each thread of that client process, the first call to the ServiceOptimizer server must always establish a connection and be authenticated. Authentication can be done either on a call by call basis, or as a single initial log on. There can not be more than one concurrent connection per thread.
There are some circumstances where an initial logon
 must be supplied (e.g. when using the Dispatch SOAP APIs).
Definition
The definition of this API is:
Web Service | Type | Description | Req? | Val? | ||
| Â | Â | Â | Â | ||
 |
|
| For an Oracle database, use the Schema name. For a SQL Server database, use the database name. | Â | ||
 |
|
| Password for the ServiceOptimizer user. | |||
 | <spUser>?</spUser> | string(50) | Valid ServiceOptimizer user. | |||
| Â | Â | Â | Â |
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are:
SP_OK (0)
SP_UNIT_INVALID (28)
SP_NET_CONNECTED (265)