Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

If there is a requirement to clear a job and take into account any spares which have been earmarked but not required, then SetJobClearedRequest should be used instead of ChangeWorkItemStatusRequest.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 

On This Page:

Related Pages:

 

Definition

The definition of this API is:

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:SetJobClearedRequest>

 

 

 

 

 

<jobID>?</jobID>

JobID

is the identifier of the job whose status is to be changed.

(tick)

(tick)

 

<dateTime>?</dateTime>

spDateTime

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.

 

 

 

<spareStock>

 

 

 

 

 

 

<spareID>?</spareID>

SpareID

Identifier for the spare

(tick)

(tick)

 

 

<spareLoc>?</spareLoc>

EmpID

EmployeeID

(tick)

(tick)

 

 

<quantity>?</quantity>

int

+ve for spares returned, -ve for extra spares used

(tick)

 

 

</spareStock>

 

 

 

 

</sp:SetJobClearedRequest>

 

 

 

 

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:

 Click here to expand...
  • SP_OK (0)
  • SP_JOBID_INVALID (1)
  • SP_EMPID_INVALID (5)
  • SP_DATE_INVALID (14)
  • SP_TIME_INVALID (29)
  • SP_OUTSIDE_HORIZON (53)
  • SP_INVALID_LOC_TYPE (78)
  • SP_STATUS_NO_CHANGE (86)
  • SP_SPAREID_INVALID (111)
  • SP_QUANTITY_INVALID (112)
  • SP_NUMLOCS_INVALID (180)
  • SP_DST_TIME_INVALID (379)
  • SP_CLEARED_TOO_LATE (385)
  • SP_SPAREID_DUPLICATED (578)

  • No labels