Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

On This Page:

Related Pages:

The sp:GetJobRequest API method can be used to obtain the details of a job.

Description

The sp:GetJobRequest API method returns job details for a given job identifier.

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:GetJobRequest>

 




 

<jobID>?</jobID>

JobID

The identifier of the job whose details are to be returned.

(tick)

(tick)


<sparesInfo>?</sparesInfo>

Boolean

Indicates whether the job spares information will be returned or not. By default the value for sparesInfo is treated as false and no job spares information is returned.(error)

<empInfo>?</empInfo>

Boolean

Indicates whether the name details of the employee allocated to the job will be returned or not. By default the value for empInfo is treated as false and no name details of the employee allocated to the job are returned.(error)

<VirtualWorkDLInfo>?</VirtualWorkDLInfo>BooleanWhen set to true, Virtual Work Dynamic Location information will be included in the response. By default the value for VirtualWorkDLInfo is treated as false and Virtual Work Dynamic Location information will not be included in the response.(error)

</sp:GetJobRequest>

 




Return Structure

The API returns a non-standard return structure.

Unable to render {include} The included page could not be found.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

  • SP_OK (0)
  • SP_JOBID_INVALID (1)

  • No labels