Pass Through Call to Scheduling's "Get Employee Jobs" API

This RESTified API will perform a pass-through call to the Scheduling sub-system's "Get Employee Jobs" API (when configured).

URL

PUT /up/v5/rest/scheduling/GetJobs

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Scheduling "Get Employee Jobs" APi.

GetEmployeeJobs Object Format

GetEmployeeJobs JSON

js

GetEmployeeJobs Object Properties (Bold property names indicate the field is required)

Property	Type	Type	Description	Req?	Field Mapping: Scheduling
`Tech`	`string`	SS: 25	Pass through parameter to the Scheduling "Get Employee Jobs" API. The identifier of the employee whose list of jobs is to be extracted; Mandatory if RespUnit not supplied. Otherwise optional.	Yes	E`mpID`
`DispatchDate`	`string`	SS: 8	Pass through parameter to the Scheduling "Get Employee Jobs" API. The date on which the jobs are to be carried out. Example: "2023-03-30"	Yes	D`ispatchDate`
`FRU`	`string`	SS: 9	Pass through parameter to the Scheduling "Get Employee Jobs" API. 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	Yes	R`espUnit`
`Options`	`object`		Pass through parameter to the Scheduling GetEmployeeJobs API.	No	see GetEmployeeJobs Jobs.Options.Objects
DispatchInfoCount	integer		A non-zero value should be supplied if Dispatch info is wanted	No	DispatchInfoCount
AuditInfoCount	integer		A non-zero value should be supplied if Audit info is wanted	No	AuditInfoCount
CustomerInfoCount	integer		A non-zero value should be supplied if Customer info is wanted	No	CustomerInfoCount
SparesInfoCount	integer		A non-zero value should be supplied if Spares info is wanted	No	SparesInfoCount
VirtualWorkDLInfo	boolean		When 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	No	VirtualWorkDLInfo

HTTP Response

Success

On success, a JSON-formatted version of the Scheduling "Get Employee Jobs" API response will be returned.

js

Error

On error, a JSON-formatted version of the Scheduling "Get Employee Jobs" API response will be returned.

js

Return Codes

In addition to the Standard Return Codes, and the Scheduling API return codes, the possible Return Codes from this API are:

SP_OK (0)
SP_JOBID_INVALID (1)
SP_EMPID_INVALID (5)
SP_DATE_INVALID (14)
SP_UNIT_INVALID (28)
SP_OUTSIDE_HORIZON (53)
SP_EMP_NOT_POSTED (178)
SP_EMPID_DOES_NOT_EXIST (231)
SP_UNIT_NOT_SUPPLIED (261)

Browser not supported