Pass Through Call to ServiceScheduling's "Get Employee Jobs" APIThis RESTified API will perform a pass-through call to the ServiceScheduling 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 "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? |
|---|
Tech | string
SS: EmpID (string)
| SS: 25 | Pass through parameter to the ServiceScheduling "Get Employee Jobs" API. The identifier of the employee whose list of jobs is to be extracted; Mandatory if RespUnit not supplied. Otherwise optional. SS Field: EmpID | Yes | DispatchDate | string
SS: spDate (string)
| SS: 8 | Pass through parameter to the ServiceScheduling "Get Employee Jobs" API. The date on which the jobs are to be carried out. Example: "2023-03-30" SS Field: DispatchDate | Yes | FRU | string
SS: FRUID (string)
| SS: 9 | Pass through parameter to the ServiceScheduling "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 SS Field: RespUnit | Yes | PrevJob | string
SS: JobID (string)
| SS: 50 | SS Field: PrevJob
No Longer in Use
|
| Options | object |
| | Property | Type | Description | Req? |
|---|
JobCount | integer | The number of jobs which should be returned in each batch. Omit if all SS Field: jobCount | No |
| No | JobInfoCount | string
SS: integer
|
| SS Field: JobInfoCount
No Longer in Use
|
| | DispatchInfoCount | string SS: integer |
| A non-zero value should be supplied if Dispatch info is wanted SS Field: DispatchInfoCount | No | | AuditInfoCount | string SS: integer |
| A non-zero value should be supplied if Audit info is wanted SS Field: AuditInfoCount | No | | CustomerInfoCount | string SS: integer |
| A non-zero value should be supplied if Customer info is wanted SS Field: CustomerInfoCount | No | | SparesInfoCount | string SS: integer |
| A non-zero value should be supplied if Spares info is wanted SS Field: SparesInfoCount | No | | VirtualWorkDLInfo | string SS: 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 SS Field: VirtualWorkDLInfo | No |
HTTP Response SuccessOn success, a JSON-formatted version of the ServiceScheduling "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 "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 the Standard 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)
|
| 