| Panel |
|---|
...
The sp:EmpRestoreRequest API method can be used to restore an operative's shift and/or locations.
...
On This Page: |
...
Related Pages: |
...
| Panel |
|---|
The sp:EmpRestoreRequest API method can be used to restore an operative's shift and/or locations. |
Description
Shifts and locations can be restored to their original values by the removal of any overrides.
A public holiday is restored as a holiday; i.e. the operative’s shift pattern won’t be restored. If an operative has assigned jobs on a public holiday, the call will succeed and return SP_OK_JOBS_ON_HOLIDAY (328). The jobs won’t be de-allocated, but, unless they are fixed, or have a status > tentative, the Optimizer may de-allocate them when it next runs if it can’t re-allocate them.
Similarly, if an operative has assigned jobs on a no-shift day, the call to sp:EmpRestoreRequest will succeed and return SP_OK_JOBS_ON_NO_SHIFT (329). The jobs won’t be de-allocated, but, unless they are fixed or have a status > tentative, the Optimizer may de-allocate them when it next runs if it can’t re-allocate them.
| Note |
|---|
This SOAP API is implemented in real time, i.e. the original shift/locations can be assumed to have been restored on a successful return from the call. |
Definition
The definition of this API is:
| Include Page | ||||
|---|---|---|---|---|
|
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:
| Include Page | ||||
|---|---|---|---|---|
|