Versions Compared

Version Old Version 2 New Version Current
Changes made by

WS (Deactivated)

Matthew Wren

Saved on

Key

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

...

Expand

Web Service

Type

Description

Req?

Val?

<sp:ApptOfferResponse>

 

 

 

 

 <returnCode>?</returnCode> This contains the standard return structure.  

 

<offers>

 

 

 

 

 

 

<offer>

 

 

 

 

 

 

 

<start>?</start>

spDateTime

The start date and time of the offer, which will fall within the inclusive date and time range between which appointments were requested using the start and end date and times parameters of the offercall to sp:ApptOfferRequest.

For jobs of long duration, that are split across multiple shifts, only the first part will be constrained to start within this band – subsequent parts will start at the beginning of the shift all of the split parts of the offer will fall within the inclusive date and time range between which appointments were requested.

 

 

 

 

 

<end>?</end>

spDateTime 

The end date and time of the offer, which will fall within the inclusive date and time range between which appointments were requested using the start and end parameters of the call to sp:ApptOfferRequest.

For jobs of long duration, that are split across multiple shifts, all of the split parts of the offer will fall within the inclusive date and time range between which appointments were requested.

 

 

 

 

 

<promBand>?</promBand>

TimeBandID

the The name of the promise band of the appointments, e.g. “M” M could be the name of the promise band between 8:30 and 12:30.For jobs of long duration, that are split across multiple shifts, only the first part will be constrained to start within this band – subsequent parts will start at the beginning of the shift.

 

 

 

 

 

<promType>?</promType>

PromTypeID

the name The type of the promise band type, e.g. “H” H could be the type (half-day?) of the promise band between 8:30 and 12:30.

 

 

 

 

 

<day>?</day>

DayOfTheWeek

indicates Indicates which day of the week the appointment falls on: “Mon”, “Tue”, “Wed”, “Thu”, “Fri”, “Sat”, “Sun”.

 

 

 

 

 

<offerToken>?</offerToken>

OfferToken

a A data item returned by ServiceOptimizer to identify each appointment in a way which is opaque to the caller. It should not be altered, but returned when Book appointmentAppointment SOAP API is called.

 

 

 

 

 

<offerText>?</offerText>

OfferText

Previous items returned in this field are now returned in specific fields within the response - DRU, FRU, IRU, empID and siteIndicator and these fields must be used to retrieve data.

Note. Cost is still returned within this field.

 

 

 

 

 

<travelTime>?</travelTime>

Intint

is the The difference in travel time between having the offer in the schedule and not having it, measured between the previous location and the next location.   If the offer is positioned in an otherwise empty operative day, travelTime is the time to travel to the job only.

Where a ‘forced’ offer is requested (i.e. InTray , InTrayWithSkills or OptNoTravel is set), travelTime is SP_IntNoValue.

The travelTime for an all-day job is the same as for a non-all-day job, i.e. not zero.

 

 

 

 

 

<DRU>?</DRU>

RUID

the The ID of the DRU that contains the FRU (below) from which this offer is being made.  If  If that FRU isn’t in a DRU, this field is empty.

 

 

 

 

 

<FRU>?</FRU>

RUID

the The ID of the FRU from which this offer is being made.

 

 

 

 

 

<IRU>?</IRU>

RUID

the The IRU containing the offer, determined as follows:

  • If the offer is for a resourced job, it’s the ID of the IRU that contains the Team that the operative provisionally assigned to the job is posted to at the time of the job.
  • If the offer is for an unresourced (forced) job, it’s the ID of the IRU that contains the Region that the job is located in.  If  If that Region is contained in more than one IRU in the FRU where the offer is being made (i.e. there are overlapping IRUs in the FRU), it’s the first IRU’s ID, ordered alphabetically.

 

 

 

 

 

<empID>?</empID>

EmpID

if If offerTextEmpID is set, is the EmpID of the operative that this offer is provisionally assigned to.

Note: For Long jobs, EmpId is always returned.

 

 

 

 

 

<siteIndicator>?</siteIndicator>

char

is, if If this offer is adjacent to an existing job on the same operative day with the same siteID or groupID, either “S”/ SameSite or “C”/SameCustomer then siteIndicator will be S (SameSite) or C (SameCustomer), respectively. 

 

 

 

 

</offer>

 

 

 

 

 

 

<more>?</more>

boolean

indicates Indicates that more appointments matching the supplied criteria are available (for example, by adding to Index index and calling sp:ApptOfferRequest again). This is only valid for ‘offers’. For ‘splitOffers’ when the offers structure is not contained within a splitOffers structure. For splitOffers, only the one offer group for each available operative is returned with any one call.

 

 

 

</offers>

 

 

 

 

</sp:ApptOfferResponse>

    

...

Note

The amount of time spent searching for available capacity can be limited by setting a value for the database parameter ABS_search_timeout.   If  If offers have been found within this time then SP_OK_ABS_SEARCH_TIMEOUT (369) is returned; if none have been found then SP_NTA_ABS_SEARCH_TIMEOUT (370) is returned instead.  ABS_search_timeout won’t be used if Reassign is to be tried, since the time allowed for re-assign is limited by the timeout ABS_reassign_timeout.

"Split Offers" Response

Expand
 

Web Service

Type

Description

Req?

Val?

<sp:ApptOfferResponse>

 

 

 

 

 <returnCode>?</returnCode> This contains the standard return structure.  

 

<splitOffers>

 

 

 

 

 

 

<group>

 

 

 

 

 

  

<groupNumber>?</groupNumber>

int

is to allow Allow the multiple offers for each long job to be grouped together – offers in the same group have the same groupNumber, which are ascending integer values starting at 1.

 

 

 

  

<groupDuration>?</groupDuration>

int

is the The total duration of the combined split parts (minsin minutes).

 

 

 

  

<groupType>?</groupType>

SplitGrpType

is one One of ContigShift, ConsecShift, or NonConsecShift and is returned . Returned with the first offer in each offer group to provide an indication of what type of offer group this is (it is undefined in the other offers in the same offer group):

  • ContigShift means that the offers in this group are
in
  • on contiguous shifts for the relevant
operative’s contiguous shift time: no interruptions except for off-shift time and public holidays
  • operative. That is, every shift that the operative will visit the site is on consecutive days;
  • ConsecShift means that the offers in this group are on consecutive shifts for the relevant
operative’s consecutive shifts, i.e.
  • operative. That is, every shift that the operative will visit the site is on consecutive
shifts (but no more than once per shift)NonConsecShift          
  • days except for off-shift time and weekends/public holidays;
  • NonConsecShift means that the offers
on
  • in this group aren’t in contiguous
shift time nor on

 

 

 

  

<offer>

 

 

 

 

 

 

 

 

 

 

Fields are as in the <offer> offer section of the "Offers" Response above plus:

 

 

 

    

<duration>?</duration>

int

The duration of the individual fragment of the split job (minsin minutes).

 

 

 

  

</offer>

 

 

 

 

 

 

</group>

 

 

 

 

 

</splitOffers>

 

 

 

 

</sp:ApptOfferResponse>

    

...

Note

The amount of time spent searching for available capacity can be limited by setting a value for the database parameter ABS_search_timeout.    If offers have been found within this time then SP_OK_ABS_SEARCH_TIMEOUT (369) is returned; if none have been found then SP_NTA_ABS_SEARCH_TIMEOUT (370) is returned instead.  ABS_search_timeout won’t be used if Reassign is to be tried, since the time allowed for re-assign is limited by the timeout ABS_reassign_timeout.

 

 

 

...