Document toolboxDocument toolbox

Update Job Priority SOAP API

Owned by Jason Andrew
Sept 17, 2024
1 min read

On This Page:

Related Pages:

The sp:ChangeJobPriorityRequest API method can be used to update the priority of a job.

Description

The sp:ChangeJobPriorityRequest API method updates the priority of an existing job.

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:ChangeJobPriorityRequest>

 

 

 

 

 

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

(tick)

(tick)

 

<NewPriority>?</NewPriority>

int

The new priority of the job.

(tick)

 

</sp:ChangeJobPriorityRequest>

 

 

 

 

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_PRIORITY_INVALID (81)
  • SP_PRIORITY_NO_COST (475)