14.1 Mandatory/Preferred/Excluded Employees (MPX)
On This Page:
Mandatory/Preferred/Excluded Employees (MPX)
The offer and booking SOAP APIs allow for employees to be specified as:
- Must do the job (i.e. Mandatory, or M);
- Are Preferred (or P) to do the job; or
- Must not do the job (i.e. Excluded, or X).
Accordingly, the Mandatory, Preferred and Excluded options are referred to simply as MPX.
MPX requirements are specified using the EmpMPX
data type.
In the offer and booking SOAP APIs it is possible to specify up to a maximum of 10 MPX employees. There may be a mixture of Excluded
and Preferred
/PreferredOrdered
but no other combination is valid.
- If there is more than one Preferred or Mandatory employee it is possible to state whether some are more preferred than others, via the
Preferred
/PreferredOrdered
orMandatory
/MandatoryOrdered
(see theEmpMPX
data type). If the supplied value isMandatory
, the appointments offered will be for the suppliedEmpID
s only. - If
EmpMPX
isPreferred
, the appointments offered could (depending on cost) be for the preferredEmpID
s and for any other operatives who can also meet the other criteria supplied. - If
EmpMPX
isMandatoryNot
(excluded), no appointments will be offered for the suppliedEmpID
.