Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ApptOfferMultRequest returns possible customer appointments which match a set of criteria where two or more appointments are required to be carried out by the same operative with an allowance for some minimum intervals between their successive end and start times:

It has three parameters:

  • The input parameter RequestInfo provides the criteria which apply to all of the individual requests which make up the multi-job appointment request
  • The input parameter Request provides the criteria for each of the appointment requests making up the multi-job appointment request
  • The output parameter, Offers, contains the appointment offers which meet the criteria in all the requests

In normal operation, it is intended that the customer would choose those offers with an appointment window which had been found to match all the appointment requirements, and then reserve those appointments in ServiceOptimizer using successive calls to the existing web service ApptBookRequest, supplying the operative ID returned in the offer’s OfferText field as the mandatory operative. Once booked, the job will be fixed in time as well as to the mandatory operative.

The description of all fields are the same as that described in section 6.3 (Offer Appointments), except where specified.


 

Definition

The definition of this API is:

include

Include Page
_API ApptOfferMultRequest Definition
_API ApptOfferMultRequest Definition

Return Structure

The API returns a non-standard return structure.

Include Page
_API ApptOfferMultRequest Response
_API ApptOfferMultRequest Response

Return Codes

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

Include Page
_API ApptOfferMultRequest Return Codes
_API ApptOfferMultRequest Return Codes