Dispatching

DispOutput is the main Web Service for the Dispatch Client. This web service is responsible for pushing out the messages to the customer's endpoint which should be created, by consuming the dispatchClient.wsdl.

Definition

Web Service

<ns2:DispOutputRequest> 
  <jobInfo> 
    <loginRequest> 
      <databaseUser>?</databaseUser> 
      <password>?</password> 
      <spUser>?</spUser> 
    </loginRequest> 
    <jobID>?</jobID> 
    <earmarkType>?</earmarkType> 
    <reEarmark>?</reEarmark> 
    <dateEarmarked>?</dateEarmarked> 
    <empID>?</empID> 
    <ETS>?</ETS> 
    <ETA>?</ETA> 
    <ETF>?</ETF> 
    <jobCountTentative>?</jobCountTentative> 
    <totalBreakTime>?</totalBreakTime> 
    <breaks> 
      <BreakName>?</BreakName> 
      <BreakType>?</BreakType> 
      <BreakStart>?</BreakStart> 
      <BreakDuration>?</BreakDuration> 
    </breaks> 
    <bookLoc>?</bookLoc> 
    <bookLocName>?</bookLocName> 
    <postcode>?</postcode> 
    <teamID>?</teamID> 
    <IRUID>?</IRUID> 
    <isVwdl>?</isVwdl>
  </jobInfo> 
</ns2:DispOutputRequest> 

<ns2:DispOutputResponse> 
  <resultCode>?</resultCode> 
</ns2:DispOutputResponse>

Description

WebService Name	Type	Description
`DatabaseUser`	`string`	For an Oracle database, use the Schema name. For a SQL Server database, use the database name.
`password`	`string`	Password for the ServiceOptimizer user defined in `spUser`.
`spUser`	`string`	Valid ServiceOptimizer user.
`jobID`	`JobID`	The ID of the earmarked job or standard activity. If a break is being dispatched without a job or SA, this value is set to -1.
`earmarkType`	`DispEarmarkTypes`	Indicates whether this request is an earmark, an unearmark, or a re-earmark, and whether the item is a job, standard activity, or standalone break. If an `UnEarmark`, only the following fields will have valid values: `jobID` `reEarmark (SP_False)` `dateEarmarked` `empID` `jobCountTentative` `bookLoc` `bookLocName` `postcode`
`reEarmark`	`boolean`	When `true`, indicates that the job's `ETA` has changed, but not its `empID`.
`dateEarmarked`	`spDateTime`	Time the work item was earmarked.
`empID`	`EmpID`	The Employee that the work item was earmarked to.
`ETS`	`spDateTime`	Time employee should start. This field is not used for standalone break dispatching.
`ETA`	`spDateTime`	Time employee should arrive. This field is not used for standalone break dispatching.
`ETF`	`spDateTime`	Time employee should finish. This field is not used for standalone break dispatching.
`jobCountTentative`	`int`	The number of jobs tentatively allocated to the employee. The `jobCountTentative` field is a count of jobs that have been allocated to the employee, but which the employee 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 the employee, 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 SPDS_Tentative or is SPDS_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, 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. When running in batch mode, then `jobCountTentative` is set to the value SP_JobCountTentativeNull. This field is not used for either standard activity or standalone break dispatching.
`totalBreakTime`	`unsigned int`	If dispatching a job or standard activity, and breaks have been scheduled to be taken during the job or standard activity, then `totalBreakTime` gives the sum of all the break durations. In this case, the `breaks` section (and therefore `BreakName`, `BreakType`, `BreakStart` and `BreakDuration`) will be empty. If dispatching a standalone break, then `totalBreakTime` gives the standalone break duration and the `breaks` section provides the details of the standalone break.
`BreakName`	`BreakName`	The name of the break. This field is only used for standalone break dispatching.
`BreakType`	`BreakType`	Type of break. If `SPEBT_Default`, the break is one as defined in the base shift definition. If `SPEBT_Overridden`, the break has been overridden by a shift override. If `SPEBT_Fixed`, the break has been fixed in place via either ServiceGANTT or the Fix Break Times SOAP API. This field is only used for standalone break dispatching.
`BreakStart`	`spDateTime`	The start time of the break. This field is only used for standalone break dispatching.
`BreakDuration`	`unsigned int`	The amount of time allowed in the schedule for this break. This field is only used for standalone break dispatching.
`bookLoc`	`BookLocID`	Booking location ID. It has the value supplied when the job was booked using the Book Appointment SOAP API, Book Dependency Group Job SOAP API, or Book Non-Appointment Job SOAP API. This field is not used for standalone break dispatching.
`bookLocName`	`BookLocName`	Any info associated, e.g. IP add/port, Q name. This field is not used for standalone break dispatching.
`postcode`	`Postcode`	Job or standard activity location postcode / zip code. This field is not used for standalone break dispatching.
`teamID`	`TeamID`	The team that the employee is posted to.
`IRUID`	`RUID`	The IRU that the team is in.
`isVwdl`	`boolean`	Only valid when the item is a job. The value indicates if the job is a Virtual Work Dynamic Location job (`true`) or not (`false`).

Browser not supported