Document toolboxDocument toolbox

14.1 Delete User SOAP API

On This Page:

Related Pages:

The sp:DeleteUserRequest API method can be used to delete users from the ServiceScheduling system, as an alternative to the ServiceManager UI for deleting users.

Description

Allows user accounts to be deleted from ServiceScheduling.

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:DeleteUserRequest>

 

 

 

 

 

<userId>?</userId>

string(50)

The User ID for the user to be deleted. The User ID must already exist in the ServiceOptimizer database.

(tick)

(tick)

</sp:DeleteUserRequest>

 

 

 

 

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_USERID_DOES_NOT_EXIST (703)