Content Comparison

<sp:ApptOfferResponse>

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

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

<promType>?</promType>

PromTypeID

The type of the promise band, 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 SOAP API is called.

<offerText>?</offerText>

OfferText

Deprecated - The information it formerly contained is Previous items returned in this field are now returned in other specific fields of the offerwithin the response i.e. EmpId. However, Cost is still returned within this field.

Note: For Long jobs, EmpId is always returned.

<travelTime>?</travelTime>

int

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

If this offer is adjacent to an existing job on the same operative day with the same siteID or groupID, then siteIndicator will be 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 sp:ApptOfferRequest again). This is only 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>