On This Page:

Related Pages:

The sp:SetPauseJobRequest API method can be used to set the "pause" status of a job.

Description

The sp:SetPauseJobRequest API method updates the "paused" status of an existing job, allowing an "in progress" job to be marked as paused, and then unpaused when work resumes.

Standard activities and all-day jobs may not be paused.

In order to be allowed to pause a job, the job must be:

Scheduled for today;
Resourced (i.e. assigned to an operative);
Not already in the "paused" state that is being set; and
Be in the "traveling" or "logged on" status.

Jobs may be paused/unpaused if the above requirements are true, even if the job is in jeopardy.

Please note the following about jobs that have been paused:

Paused jobs will not be moved by the optimizer; however, they can be moved manually in the Gantt without warning.
Incompleted jobs in the "paused" state will go into jeopardy (under "Late Logged OFF" - "Late Logged ON") and will require manual intervention from a dispatcher.
Paused/unpaused a job does not affect the job's duration. Only when a job is moved to the "loggedoff" status will the job duration be extended.
Paused jobs can still be canceled.
Paused jobs will be automatically unpaused when their status is updated.

Definition

The definition of this API is:

Web Service		Type	Description	Req?	Val?
`<sp:SetPauseJobRequest>`
	`<jobID>?</jobID>`	`JobID`	The identifier of the job to be updated. The error `SP_JOBID_INVALID (1)` will be returned if the supplied `JobID` does not exist in the ServicePower database.
	`<setJobToPause>?</setJobToPause>`	`boolean`	When `true`, set the job to the "paused" status; when `false`, set the job to the "unpaused" status.
`</sp:SetPauseJobRequest>`

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:

SP_JOBID_INVALID (1)
SP_JOB_OUT_OF_SCOPE (816)
SP_UNRESOURCED_JOB_NOT_PAUSABLE (817)
SP_JOB_IS_PAUSED (818)
SP_JOB_IS_UNPAUSED (819)
SP_ALL_DAY_JOB_NOT_PAUSABLE (820)
SP_JOB_NOT_PAUSABLE (821)

Browser not supported