_API DispRequest Response

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

<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

Time employee should start. This field is not used for stand alone break dispatching.

<ETA>?</ETA>

Time employee should arrive. This field is not used for stand alone break dispatching.

<ETF>?</ETF>

Time employee should finish. This field is not used for stand alone break dispatching.

<jobCountTentative>?</jobCountTentative>

int

Number of jobs tentatively allocated to this EmpID.  JobCountTentative is a count of jobs that have been allocated to this employee (EmpID), but which he doesn’t yet know about.  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, JobCountTentative is the number of jobs, not including this one being earmarked, that are currently allocated to this EmpID, while he’s 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, 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, JobCountTentative returns the number of remaining jobs for today.   JobCountTentative is only returned when dispatch is being done in real time mode. If it’s running in batch mode, then JobCountTentative is set to -1

This field is not used for either standard activity or stand alone break dispatching

<totalBreakTime>?</totalBreakTime>

nsigned int

sum of all durations of included breaks. If breaks have been scheduled to be taken during the job or standard activity, TotalBreakTime gives the sum of all break durations and ScheduledBreaks provides the list of those breaks, otherwise it is null.

<breaks>

<BreakName>?</BreakName>

BreakName

Name of the break (see §2.3)

<BreakType>?</BreakType>

BreakType

Type of break. If a BreakType = Default the break is one as defined in the base shift definition. If the BreakType = Overridden the break has been overridden by a shift override. If the BreakType = 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>

nsigned int

The amount of time allowed in the schedule for this break

</breaks>

<bookLoc>?</bookLoc>

BookLocID

Booking location ID.  It has the value supplied when the job was booked using ApptBookRequest(see 6.3) or JobBookRequest (see 6.6).  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>

Team that EmpID is posted to

<IRUID>?</IRUID>

RUID

IRU that Team is in

</jobInfo>

</sp:DispRequestResponse>