_API GetChangedWorkItemsRequest Response

Click here to 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.
	`<workItem>`
		`<workItemID>?</workItemID>`		`WorkItemID`	The identifier of the work item.
		`<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>`	`DisStatus`	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>`

Note: There is no guarantee that a changed work item is returned only once for each change.

Note: Because a work item is returned if any of its attributes have changed (unless JeopOnly is set), not just a change to those attributes returned, there will be circumstances when a work item is returned for which there has been no change apparent in the attributes returned.

Note: If a job is cancelled (via the Integration ServiceOptimizer Cancel Job SOAP API), or a standard activity removed, nothing will be reported about it thereafter, since it will have been removed from ServiceOptimizer. It’s assumed that the same system that called the Integration ServiceOptimizer Cancel Job SOAP API will be calling the Integration ServiceOptimizer Get Changed Work Items SOAP API and will therefore know not to expect anything to be reported about the job after cancellation.

All of the fields to do with dates and times are local to what is specified in the tz_GCJAPI database parameter. These can be set such that dates and times are local to the timezone of the region where the work item is located, local to the timezone of the responsibility unit which contains the work item, local to the employee that the work item is allocated to, local to a specified or default timezone, or in GMT with or without daylight saving (BST).