/
_API GetJobsRequest Definition
Document toolboxDocument toolbox

_API GetJobsRequest Definition

Owned by Matthew Wren (Unlicensed)
Nov 24, 2022
 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:GetJobsRequest>





 

<EmpID>?</EmpID>

EmpID

is the identifier of the employee whose list of jobs is to be extracted; Mandatory if RespUnit not supplied. Otherwise optional

(error)

(tick)

 

<DispatchDate>?</DispatchDate>

spDate

is the date on which the jobs are to be carried out

(tick)


 

<RespUnit>?</RespUnit>

RUID

is the FRU for which unresourced jobs are to be extracted. If EmpID is supplied as well as RespUnit, EmpID is ignored.

Mandatory if EmpID and Dispatch Date not supplied. Otherwise optional

(error)

(tick)

 

<PrevJob>?</PrevJob>

JobID

No longer in use

(error)



<JobCount>?</JobCount>

int

is the number of jobs which should be returned in each batch. Omit if all

(error)


 

<JobInfoCount>?</JobInfoCount>

int

Not used

(error)



<DispatchInfoCount>?</DispatchInfoCount>

int

A non-zero value should be supplied if Dispatch info is wanted

(error)


 

<AuditInfoCount>?</AuditInfoCount>

int

A non-zero value should be supplied if Audit info is wanted

(error)


 

<CustomerInfoCount>?</CustomerInfoCount>

int

A non-zero value should be supplied if Customer info is wanted

(error)


 

<SparesInfoCount>?</SparesInfoCount>

int

A non-zero value should be supplied if Spares info is wanted

(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:GetJobsRequest>

 




All of the fields to do with dates and times are local to what is specified in the tz_GJAPI database parameter for resourced jobs and local to what is specified in the tz_GJAPIUnres database parameter for unresourced jobs (see [1]). These can be set such that dates and times are local to the timezone of the responsibility unit which contains the job, local to the employee that the job is allocated to (if it’s resourced), local to a specified or default timezone, or in GMT with or without daylight saving (BST).