Pass Through Call to

Scheduling's "DeleteUserRequest" API

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

URL

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 ServiceScheduling Scheduling "DeleteUserRequest" API.

Deleteuser Object Format

{
	"userId": ""
}

DeleteAct Object Properties (Bold property names indicate required field)

HTTP Response

Success

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

{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "result": {
            "type": "OK",
            "code": "0"
        }
    }
}

Error

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

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "code": "SCH Error Code"
        }
    }
}

Return Codes

In addition to to the  Standard Return Codes, and the general ServiceScheduling Return Codes, the specfic ones for the Scheduling Error codes, the possible Return Codes from this API are: