Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SCHUD and version 9.4
Expand

Web Service

Type

Description

Req?

Val?

<sp:GetChangedWorkItemsResponse>

 

 

 

 

 

<timeStampOut>?</timeStampOut>

timeStamp

TimeStampOut will normally be the time of this call to the Integration ServiceOptimizer Get Changed Work Items SOAP API (unless the supplied array is too small) and TimeStampIn will usually be the TimeStampOut returned from the previous call. 

(tick)

(error)

 

<workItem>

 

 

(tick)

 

 

 

<workItemID>?</workItemID>

WorkItemID

The identifier of the work item.

(tick)

 

 

 

<workItemType>?</workItemType>

WorkItemType

Identifies whether a job or a standard activity.

 

 

 

 

<isFixed>?</isFixed>

Boolean

 

 

 

 

 

<jobJeopardy>

 

 

 

 

 

 

 

JeopStates

All of the jeopardy states for the work item, irrespective of whether they are in the configured set or not.

 

 

 

 

</jobJeopardy>

 

 

 

 

 

 

<attr>

 

This element is not returned for an unresourced job.

 

 

 

  

<empID>?</empID>

EmpID

The identifier of the operative that the job is allocated to.

 

 

 

  

<start>?</start>

spDateTime

The date and time that the operative is scheduled to start travelling to the job.

 

 

 

  

<arrival>?</arrival>

spDateTime

The date and time that the operative is scheduled to arrive at the job.

 

 

 

  

<finish>?</finish>

spDateTime

The date and time that the operative is scheduled to finish the working part of the job, i.e. excluding travel home if there is any.

 

 

 

  

<disStatus>?</disStatus>

dispatchStatusDisStatus

The current dispatch status of the job, i.e. Tentative, Earmarked, Contacted, Started (Travelling), Logged On , Logged Off or Cleared.

 

 

 

  

<overdue>?</overdue>

int

Irrespective of whether overdue (P) or late appointment (M) or early (B or Me) is a configured jeopardy condition for this call, this is the amount by which the job is either:

  • late if it’s an appointment (i.e. the time after its appointment latest), or
  • overdue if it’s not an appointment (i.e. the time after its contract latest, taking its service hours into account), or
  • early i.e. the time before its appointment earliest if it’s an appointment or before its contract earliest, taking service hours into account, if it’s not.

If it’s scheduled but isn’t overdue or late or early, overdue is 0.

 

 

 

 

</attr>

 

 

 

 

 

</workItem>

 

 

 

 

</sp:GetChangedWorkItemsResponse>

 

 

 

 

...