Document toolboxDocument toolbox

Disconnect SOAP API

The sp:spQuit API method can be used to close a connection to ServiceOptimizer.

Description

When a client thread has finished its session, it should disconnect from ServiceOptimizer.

If a SOAP API call has been made with the login information included in the call, and ‘Keep Alive’ is not enabled, then the connection will automatically be closed and no disconnection special call is required.

However, if a client thread has created a session via the Login SOAP API, then the client thread should use sp:spQuit to ensure the connection is closed. 

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:spQuit/>

 

 

 

 

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)