UnloadEmployees Method

UnloadEmployees updates the schedule for an employee by adding new exception hours to the cache. This method applies when employees are unavailable as a result of vehicle breakdown and so on. The activities scheduled during the exception hours for the employee are rescheduled or unscheduled. Activities are rescheduled for any open slots that meet the hard constraints. Employees must have at least 1 defined exception hour.

Invoked From

This method is called when a user clicks the Unavailable button (in the Employees view in the Service Region List of the Administration - Scheduling screen).

Arguments

The following table describes the arguments for this method.

Argument Name	Description
SvcRegnId	The service region ID of the employees to unload.
EmployeeIds	The comma-separated employee IDs. However, the Optimizer processes only 1 employee ID at a time. If more than 1 employee ID is provided, then the Optimizer processes only the first employee ID.

Return Values

The following table describes the return values for this method.

Return Value	Description
Message	The Optimizer error tracing message that is returned if an error occurs.
ErrorCode	The error code returned from the Optimizer. A value of 0 indicates the operation is successful.