Pass Through Call to ServiceSchedulingScheduling's "Get Employee Jobs" APIThis RESTified API will perform a pass-through call to the ServiceScheduling Scheduling sub-system's "Get Employee Jobs" API (when configured). URL| Panel |
|---|
| borderColor | grey |
|---|
| bgColor | whitesmoke |
|---|
| borderStyle | solid |
|---|
| PUT /up/v5/rest/scheduling/GetJobs
|
HTTP Request BodyThis request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceScheduling the Scheduling "Get Employee Jobs" APi. | Code Block |
|---|
| language | js |
|---|
| title | GetEmployeeJobs JSON |
|---|
| collapse | true |
|---|
| {
"Tech": "EmpId",
"DispatchDate": "DispatchDate",
"FRU": "",
"PrevJob": "",
"Options": {
"JobCount": 1
},
"JobInfoCount": "",
"DispatchInfoCount": "",
"AuditInfoCount": "",
"CustomerInfoCount": "",
"SparesInfoCount": "",
"VirtualWorkDLInfo": ""
} |
GetEmployeeJobs Object Properties (Bold property names indicate the field is required)| Property | Type | Type | Description | Req? | Field Mapping: ServiceScheduling Scheduling |
|---|
Tech | string
| SS: 25 | Pass through parameter to the ServiceScheduling 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 | EmpID | DispatchDate | string
| SS: 8 | Pass through parameter to the ServiceScheduling the Scheduling "Get Employee Jobs" API. The date on which the jobs are to be carried out. Example: "2023-03-30" | Yes | DispatchDate | FRU | string
| SS: 9 | Pass through parameter to the ServiceScheduling 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 | RespUnit | Options | object |
| Pass through parameter to the ServiceScheduling 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 SuccessOn success, a JSON-formatted version of the ServiceScheduling Scheduling "Get Employee Jobs" API response will be returned. | Code Block |
|---|
| {
"Success": true,
"Code": "0",
"Message": "",
"Payload": {
"result": {
"type": "OK",
"code": "0"
},
"OffsetId": "JobID",
"OffsetCount": "JobCount",
"WorkItems": [
{WorkItem CDM}
]
}
} |
Error On error, a JSON-formatted version of the ServiceScheduling Scheduling "Get Employee Jobs" API response will be returned. | Code Block |
|---|
| {
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"code": "SCH Error Code"
}
}
} |
Return CodesIn addition to to the Standard Return Codes, and the general ServiceScheduling Return Codes, the specfic ones for Scheduling API return codes, the possible Return Codes from this API are: | Expand |
|---|
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)
|
| 