_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. If the parameter is not supplied, no change will be made to the related value.

<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.).

If the parameter is not supplied, no change will be made to the related value.

<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), the OpenAccHoursOvrs parameter must not be supplied, 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.

If this parameter is not supplied, no changes to access hours will be made as a result of this call.

Both start and end must be specified.

<start>?</start>

is the date-time at which the override starts.

<end>?</end>

is the date time at which the override ends.

</openAccHoursOvrs>

<closedAccHoursOvr>

<start>?</start>

is the date-time at which the override starts. 

<end>?</end>

is the date time at which the override ends.

</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 the "Offer/Book Options" for the definitions of the permitted options listed below.

If both FixToEmp and RemoveMandatory are supplied, SP_OPTION_COMBINATION_INVALID (159) will be returned

<FixToEmp>?</FixToEmp>

<UseAccessHours>?</UseAccessHours>

The UseAccHours parameter is only valid if no OpenAccHoursOvrs are supplied. If OpenAccHoursOvrs are supplied and UseAccHours is set, the call will fail with return code SP_OPT_USE_AH_INVALID (450).

<SetNotFixed>?</SetNotFixed>

<SetUnEarmark>?</SetUnEarmark>

If SetUnEarmark 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>

<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>