Click here to expand...

Web Service				Type	Description	Req?	Val?
`<sp:DispRequestResponse>`
	`<jobInfo>`
		`<jobID>?</jobID>`		`JobID`	ID of earmarked job or standard activity. If a break is being dispatched without a job or SA this value is set to -1.
		`<earmarkType>?</earmarkType>`		`DispEarmarkTypes`	On return, indicates whether this request is an earmark, an unearmark or a re-earmark and whether the item is a job/break, or a standard activity. If the value is `UnEarmark`, only the following fields have valid values: `JobID`, `ReEarmark` (`SP_False`), `DateTime`, `EmpID`, `JobCountTentative`, `BookLoc`, `BookLocName`, and `Postcode`. In addition, if configured, the value of `None` may be returned to indicate that the job has changed jeopardy state.
		`<reEarmark>?</reEarmark>`		`boolean`	Indicates that this item’s ETA has changed, but not its `EmpID`.
		`<dateEarmarked>?</dateEarmarked>`		`spDateTime`	Time the work item was earmarked.
		`<empID>?</empID>`		`EmpID`	Employee it was earmarked to.
		`<ETS>?</ETS>`		`spDateTime`	The time the employee should start. This field is not used for stand-alone break dispatching.
		`<ETA>?</ETA>`			The time the employee should arrive. This field is not used for stand-alone break dispatching.
		`<ETF>?</ETF>`			The time the employee should finish. This field is not used for stand-alone break dispatching.
		`<jobCountTentative>?</jobCountTentative>`		`int`	The number of jobs tentatively allocated to this `EmpID`. The `jobCountTentative` field is a count of jobs that have been allocated to this employee (`EmpID`), but which they do not know about yet. Its value depends on the value of the database parameter `disp_job_count_tentative_days`. If `disp_job_count_tentative_days` not present or has the value 0, then `jobCountTentative` is the number of jobs, not including this one being earmarked, that are currently allocated to this `EmpID`, while the employee is posted to the FRU containing this job, between now and the end of the Reactive Working Period (TWP – measured over operative days), whose status is `Tentative` or is `Earmarked` but which hasn’t yet been successfully dispatched. If `disp_job_count_tentative_days` is non-zero, then `jobCountTentative` only returns the number of jobs for that number of days instead of for the Reactive Working Period. For example, if `disp_job_count_tentative_days` is 1, then `jobCountTentative` returns the number of remaining jobs for today. A `jobCountTentative` value is only returned when dispatch is being done in real-time mode. If it’s running in batch mode, then `jobCountTentative` will be set to -1. This field is not used for either standard activity or stand-alone break dispatching. Alternatively, when the `earmarkType` value is set to `None`, indicating that the `jobInfo` represents a job that has changed jeopardy state, then `jobCountTentative` will be set to the Jeopardy State Type 1 value that, combined with the Jeopardy State Type 2 value returned in the `totalBreakTime` field, represents the jeopardy state that the job is now in. When the `earmarkType` value is set to `None` and `jobCountTentative` and `totalBreakTime` are both 0, then this indicates that the job has changed jeopardy state so that is is no longer in jeopardy.
		`<totalBreakTime>?</totalBreakTime>`		`unsigned int`	The sum of all durations of included breaks. If breaks have been scheduled to be taken during the job or standard activity, then `totalBreakTime` gives the sum of all break durations and `ScheduledBreaks` provides the list of those breaks, otherwise, it is null. Alternatively, when the `earmarkType` value is set to `None`, indicating that the `jobInfo` represents a job that has changed jeopardy state, then `totalBreakTime` will be set to the Jeopardy State Type 2 value that, combined with the Jeopardy State Type 1 value returned in the `jobCountTentative` field, represents the jeopardy state that the job is now in. When the `earmarkType` value is set to `None` and `jobCountTentative` and `totalBreakTime` are both 0, then this indicates that the job has changed jeopardy state so that is is no longer in jeopardy.
		`<breaks>`
			`<BreakName>?</BreakName>`	`BreakName`	The name of the break (see §2.3)
			`<BreakType>?</BreakType>`	`BreakType`	The type of break. If the `BreakType` is `Default` the break is as defined in the base shift definition. If the `BreakType` is `Overridden` the break has been overridden by a shift override. If the `BreakType` is `Fixed` the break has been fixed in place via either the Gantt or the FixBreakTimesRequest web service
			`<BreakStart>?</BreakStart>`	`Time`	The time the break is scheduled to start.
			`<BreakDuration>?</BreakDuration>`	`unsigned int`	The amount of time allowed in the schedule for this break.
		`</breaks>`
		`<bookLoc>?</bookLoc>`		`BookLocID`	The booking location ID. It has the value supplied when the job was booked using the Integration ServiceOptimizer Book Appointment SOAP API or the Integration ServiceOptimizer Book Non-Appointment Job SOAP API. This field is not used for stand-alone break dispatching.
		`<bookLocName>?</bookLocName>`		`BookLocName`	Any info associated, e.g. IP add/port, Q name. This field is not used for stand-alone break dispatching.
		`<postcode>?</postcode>`		`Postcode`	Job or standard activity Location. This field is not used for stand-alone break dispatching.
		`<teamID>?</teamID>`			The team that `EmpID` is posted to.
		`<IRUID>?</IRUID>`		`RUID`	The IRU that the team is in.
	`</jobInfo>`
`</sp:DispRequestResponse>`

The values of the DateTime, ETS, ETA and ETF fields are local to what is specified in the tz_disp_api database parameter unless APITimeZone was supplied in the previous call to DispInitRequest see Integration ServiceOptimizer Initialize Dispatch Queue SOAP API.

tz_disp_api can be configured to be local to the customer (i.e. to the region where the job is located), local to a supplied or default time zone, to the responsibility unit containing the job, to the employee, to the ServiceOptimizer or SMS server, or in GMT, with or without daylight saving (BST).

The value BreakStart is local to tz_disp_api unless APITimeZone was supplied in Integration ServiceOptimizer Initialize Dispatch Queue SOAP API. The exception is where the specified timezone is local to Customer in which case BreakStart is local to the Employee.

If tz_disp_api is set to be RU-local and the employee (EmpID) is posted at the time this job is scheduled to begin to an IRU that has a timezone, then DateTime, ETS, ETA, and ETF will be local to that IRU’s timezone.

Both EarmarkType and JobEarmarkInfo are populated only if SP_OK (0) is returned.

Browser not supported