Pass Through Call to Scheduling's "DeleteUserRequest" API

This RESTified API will perform a pass-through call to the Scheduling sub-system's "DeleteUserRequest" API (when configured).

URL

PUT /up/v5/rest/scheduling/DeleteUser

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Scheduling "DeleteUserRequest" API.

Deleteuser Object Format

ActDelete JSON

js

DeleteAct Object Properties (Bold property names indicate required field)

Property

Type

Length

Description

Req?

userID

string

SS: 50

Unique identifier for user to be deleted

SS Field Mapping: userID

Yes

HTTP Response

Success

On success, a JSON-formatted version of the Scheduling "DeleteUserRequest" API response will be returned.

js

Error

On error, a JSON-formatted version of the Scheduling "DeleteUserRequest" API response will be returned.

js

Return Codes

In addition to the Standard Return Codes, and the Scheduling Error codes, the possible Return Codes from this API are:

SP_USERID_DOES_NOT_EXIST (703)

Browser not supported