_API ApptOfferRequest Response

<sp:ApptOfferResponse>

<offers>

<offer>

<start>?</start>

spDateTime

the start and end date and times of the offer

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.

<end>?</end>

spDateTime

<promBand>?</promBand>

TimeBandID

the name of the promise band of the appointments, e.g. “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 of the promise band type, e.g. “H” could be the type (half-day?) of the promise band between 8:30 and 12:30.

<day>?</day>

DayOfTheWeek

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

<offerToken>?</offerToken>

OfferToken

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 appointment is called.

<offerText>?</offerText>

OfferText

<travelTime>?</travelTime>

Int

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

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

<DRU>?</DRU>

RUID

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

<FRU>?</FRU>

RUID

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

<IRU>?</IRU>

RUID

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 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 offerEmpID is set, is the EmpID of the operative that this offer is provisionally assigned to.

<siteIndicator>?</siteIndicator>

char

is, 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 respectively. 

</offer>

<more>?</more>

boolean

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

</offers>

</sp:ApptOfferResponse>

<sp:ApptOfferResponse>

<splitOffers>

<group>

<groupNumber>?</groupNumber>

int

is to 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 total duration of the combined split parts (mins)

<groupType>?</groupType>

SplitGrpType

is one of ContigShift, ConsecShift, NonConsecShift and is 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 the relevant operative’s contiguous shift time: no interruptions except for off-shift time and public holidays

ConsecShift means that the offers in this group are on the relevant operative’s consecutive shifts, i.e. the operative will visit the site on consecutive shifts (but no more than once per shift)

NonConsecShift           means that the offers on this group aren’t in contiguous shift time nor on consecutive shifts, but will still be no more than Long Job: Max Fragment Gap days apart.

<offer>

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

<duration>?</duration>

int

The duration of the individual fragment of the split job (mins)

</offer>

</group>

</splitOffers>

</sp:ApptOfferResponse>