Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand

Web Service

Type

Description

Req?

Val?

<sp:ChangeWorkItemStatusRequest>

 

 

 

 

 

<workItemStatusChange>

 

 

(tick)

 

 

 

<workItemID>?</workItemID>

WorkItemID

is the identifier of the job or standard activity whose status is to be changed.

(tick)

(tick)

 

 

<workItemType>?</workItemType>

workItemType

Identifies whether this is an update to a job or standard activity

(tick)

 

 

 

<newStatus>?</newStatus>

dispatchStatus

is the value the status of this work item is to be set to. SP_INVALID_STATUS (45)will be returned if the WorkItem is a standard activity that cannot be dispatched.

(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

(error)

 

 

</workItemStatusChange>

 

 

 

 

</sp:ChangeWorkItemStatusRequest>

 

 

 

 

...

Note

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). 

NOTE:  There are circumstances where this call will cause the work item tospDateTime span the time when a break may be taken by the operative, so the time recorded may be different from the time expected.

Adjustments to a work item’s Start time, Arrival time and Finish time depend on both the current dispatch status and the new status passed to ChangeWorkItemStatusRequest:

...