Description

The sp:ApptOfferRequest API method returns possible customer appointments which match a set of criteria.

The response will either return an offers structure or a splitOffers structure (see below). The number of individual offers in either response structure can vary and are returned in total cost order, with the lowest cost being first.

Offers

In conversation with the consumer, an appropriate offer can be chosen and the corresponding job booked. Offers (in an offers structure) must be booked using the Book Appointment SOAP API.

Split Offers

When a call to sp:ApptOfferRequest is for a job whose job type specifies that it can be fragmented and the job is of sufficient duration, a set of offers called an offer group may be returned. (In some cases, where the length of the job is greater than the Long Job: Split Threshold but less than the length of the operative’s shift, a single offer can be returned as well.) All of the offers in an offer group are for the same operative. Where the last part of the job is short enough, the previous job is the last job in its shift, and the AllowEmpOT option has been set, it will be included as AOT in that previous shift; this will save the extra visit.

...

Thereafter, the functionality available (e.g. Gantt, SOAP call, dispatch, jeopardy) is the same as for any other dependency group.

Definition

The definition of this API is:

Return Structure

The API returns a non-standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

...