Integration ServiceOptimizer Set Job Status to Cleared SOAP API
- Andrew Hill (Deactivated)
- f.anwar (Deactivated)
On This Page:
Related Pages:
The sp:SetJobClearedRequest API method can be used to clear a job, taking into account spares which have been earmarked but not required.
Description
If there is a requirement to clear a job and take into account any spares which have been earmarked but not required, then sp:SetJobClearedRequest should be used instead of the Change Work Item Status SOAP API.
If fru_fj_auto_on is set in the ServiceOptimizer database, a search will be made for a job to be automatically allocated after this one.
Definition
The definition of this API is:
Web Service | Type | Description | Req? | Val? | ||
|
|
|
|
| ||
|
|
| is the identifier of the job whose status is to be changed. |
|
| |
|
|
| is the date and time at which this status change is to be recorded as having happened. The default value is the current system date and time. |
|
| |
|
|
|
|
|
| |
|
|
| Identifier for the spare |
|
| |
|
|
| EmployeeID |
|
| |
|
|
| +ve for spares returned, -ve for extra spares used |
|
| |
|
|
|
|
|
| |
|
|
|
|
| ||
The value of the dateTime timestamp is local to what is specified in the tz_CJS database parameter.
This can be set such that dateTime is local to the timezone of the region where the job is located, local to the timezone of the responsibility unit which contains the job, local to the employee that the job is allocated to, local to a specified or default timezone, or in GMT with or without daylight saving (BST).
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are: