UpdateJob RESTified API
- Mickey Bushman
- Jason Andrew
Pass Through Call to Scheduling's "Job Update Request" API
This RESTified API will perform a pass-through call to the Scheduling sub-system's "Job Update Request" API (when configured).
URL
PUT /up/v5/rest/scheduling/UpdateJob
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 "Job Update Request" API.
Update Object Format
| Property | Type | Length | Description | Req? | Field Mapping: Scheduling | |
|---|---|---|---|---|---|---|
Id |
| SS: 50 | Caller’s identifier of the job to be updated. It must exist in the database otherwise SP_JOBID_INVALID (1) is returned. | Yes | jobID | |
| Priority | integer | Priority the job should be given. If the parameter is not supplied, no change will be made to the related value. | No | priority | ||
| Importance | Integer | Importance the job should be given. (Normally a ‘confirmed’ job’s Importance should be raised to make it less likely that the job will be deallocated.). If the parameter is not supplied, no change will be made to the related value. | No | importance | ||
| OpenAccHoursOvrs | object | These two fields, along with the UseAccHours Option (below) can optionally be used to make changes to the job’s Access Hours: 1) If UseAccHours is not set, OpenAccHoursOvrs and ClosedAccHoursOvr replace all of the job’s existing access hours (from both access hours patterns and existing access hours overrides). 2) If UseAccHours is set, ClosedAccHoursOvr can be supplied (a single closed period), the OpenAccHoursOvrs parameter must not be supplied, otherwise SP_OPT_USE_AH_INVALID (450) is returned. If the job’s existing ETA wouldn’t be within its resulting access hours, SP_ETA_OUTSIDE_ACC_HOURS (447) is returned. (There is no override.) ClosedAccHoursOvr takes precedence over existing and supplied open access hours. If this parameter is not supplied, no changes to access hours will be made as a result of this call. Both start and end must be specified. | No | |||
| CheckEmp | string | SS: 25 | Operative that the job should already be allocated to. If it isn’t, SP_WRONG_EMP (492) is returned. If this check isn’t required, the field should be omitted | No | checkEmp | |
| ClosedAccHoursOvr | object | Pass through parameter to the Scheduling UpdateJob API. | No.options | |||
| Customer | object | Customer information for the job. | No | |||
| Options | object | Provides the ability to update the options associated with the job. If both | No | |||
HTTP Response
Success
On success, a JSON-formatted version of the Scheduling "Job Update Request" API response will be returned.
{
"Success": true,
"Code": "0",
"Message": "",
"Payload": {
"result": {
"type": "OK",
"code": "0"
}
}
}
Error
On error, a JSON-formatted version of the Scheduling "Job Update Request" API response will be returned.
{
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"code": "SCH Error Code"
}
}
}
Return Codes
In addition to the Standard Return Codes, and the Scheduling API return codes, the possible Return Codes from this API are:
Please Note:
The sp:JobUpdateRequest SOAP API can not be called for an Appointment: SP_JOB_IS_APPOINTMENT (477) will be returned.
The sp:JobUpdateRequest SOAP API can only be called for resourced Jobs except when only updating Customer, Priority and/or Importance: SP_UNRESOURCED_JOB (148) is returned.
It can also only be called for Jobs whose dispatch status isn’t Logged Off or Cleared: SP_CLEARED_JOB (493) is returned otherwise.