| Panel |
|---|
...
The sp:EmpOverrideRequest API method can be used to override an operative's shift and/or locations.
...
On This Page: |
...
Related Pages: |
...
| Panel |
|---|
The |
Description
The sp:EmpOverrideRequest API method allows an operative’s shift and/or locations (start, end, and local knowledge) to be overridden for a required date.
The existing shift (or existing shift override) of an operative (EmpID) is overriden on the supplied Date if ShiftPeriod is supplied (i.e. not NULL).
Similarly, the existing locations (or existing location overrides) of an operative is overridden on the supplied Date if EmpLocs is supplied (not NULL).
Without any options set, a shift override will not be generated (if supplied) for a Date when the operative would not normally be on shift (i.e. has a shift period in their assigned shift pattern or an existing shift override) or is on a public holiday (SP_NO_SHIFT or SP_HOLIDAY will be returned, respectively).
| Note |
|---|
Jobs will be shuffled after the overrides have been applied. This may result in some jobs being shuffled outside their access hours. |
| Note |
|---|
If, as a result of an |
| Note |
|---|
This SOAP API is implemented in real time, i.e. the overrides can be assumed to have taken effect on successful return from the call. |
The underlying shift from a shift pattern, if there is one, can be restored by using the Shift and Location Restore SOAP API.
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 | ||||
|---|---|---|---|---|
|