_API JobUpdateRequest Definition

<sp:JobUpdateRequest>

<jobID>?</jobID>

JobID

is the caller’s identifier of the job to be updated. It must exist in the database otherwise SP_JOBID_INVALID (1) is returned.

<priority>?</priority>

is the new Priority the job should be given ().

<importance>?</importance>

is the new Importance the job should be given (). (Normally a ‘confirmed’ job’s Importance should be raised to make it less likely that the job will be deallocated.)

<openAccHoursOvrs>

These two fields, along with the UseAccHours Option (below) can optionally be used to make changes to the job’s Access Hours:

1) If UseAccHours is not set, OpenAccHoursOvrs and ClosedAccHoursOvr replace all of the job’s existing access hours (from both access hours patterns and existing access hours overrides).

2) If UseAccHours is set, ClosedAccHoursOvr can be  supplied (a single closed period), but OpenAccHoursOvrs must be NULL, otherwise SP_OPT_USE_AH_INVALID (450) is returned.

If the job’s existing ETA wouldn’t be within its resulting access hours, SP_ETA_OUTSIDE_ACC_HOURS (447) is returned. (There is no override.)

ClosedAccHoursOvr takes precedence over existing and supplied open access hours.

<start>?</start>

<end>?</end>

</openAccHoursOvrs>

<closedAccHoursOvr>

<start>?</start>

<end>?</end>

</closedAccHoursOvr>

<checkEmp>?</checkEmp>

is the Operative that the job should already be allocated to.  If it isn’t, SP_WRONG_EMP (492) is returned.  If this check isn’t required, the field should be omitted

<customer>

is information about the customer that this job is for.( See section 4.4.3)

</customer>

<options>

(see section 4.2 for use of options)

If both fixToEmp and removeMandatory are supplied, SP_OPTION_COMBINATION_INVALID (159) will be returned

<FixToEmp>?</FixToEmp>

fixToEmp will cause the currently allocated operative to be made the mandatory Operative for the job.

<UseAccessHours>?</UseAccessHours>

UseAccHours is only valid if no OpenAccHoursOvrs are supplied.  Its effect is to cause AHOs to be generated from the job’s existing access hours (which may be from an access hours pattern) that overlap the same Operative Day on which the job’s ETA is current scheduled.  If the job has no access hours on that Operative Day, a single AHO from the start of the Operative Day to the end will be set.  If OpenAccHoursOvrs are supplied and UseAccHours is set, the call will fail with return code SP_OPT_USE_AH_INVALID (450)

<SetNotFixed>?</SetNotFixed>

setNotFixed will cause the Fixed flag to be removed, if it were previously set.

<UnEarmark>?</UnEarmark>

If unEarmark is set without setDispStatusBack being set, SP_OPTION_COMBINATION_INVALID (159) will be returned.

<SetDispStatusBack>?</SetDispStatusBack>

setDispStatusBack will cause the job’s dispatch status to be set to SPDS_Tentative. If unEarmark is also set and unearmark message will be dispatched if the job’s current status is Earmarked, Contacted, Travelling, or LoggedOn.

<SetConfirmed>?</SetConfirmed>

setConfirmed sets the ConfirmedState of the job to Confirmed.

<RemoveMandatory>?</RemoveMandatory>

removeMandatory, will cause any previously specified mandatory operatives to be removed from the job.  An error won’t be returned if the job has no mandatory operatives.  This option has no effect on preferred or excluded operatives.

</options>

</sp:JobUpdateRequest>