_API OfferAppsMultRequest Definition

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<sp:ApptOfferMultRequest>`
	`<RequestCount>?</RequestCount>`		`Unsigned int`	the total number of individual appointments in the overall job
	`<MultOptions>`			See the "Offer/Book Options" for the definitions of the permitted `MultOptions` listed below.
		`<OfferBestOnlyPerEmp>?</OfferBestOnlyPerEmp>`
		`<RestrictSearch>?</RestrictSearch>`
	`</MultOptions>`
	`<MinPartialMatchCount>?</MinPartialMatchCount>`		`Unsigned int`	MinPartialMatchCount determines whether partial matches are to be returned. If, for example, RequestCount is 4 and MinPartialMatchCount is 2, and a set of 4 offers is not available for a particular employee, then partial offers containing 3 and 2 offers will be returned. In this case 4 offers will still be returned, but the ones where there is no match will be null, i.e. the first field of the SP_ApptOffer, ApptDate, will be an empty string (“”). If RequestCount and MinPartialMatchCount have the same value, no partial matches will be returned
	`<OfferAppts>`			The `OfferAppts` structure is the same as defined for `sp:ApptOfferRequest` API method in the Request Appointments SOAP API, but with the following exclusions listed below.
		`<band></band>`		The entire `band` structure of the `sp:ApptOfferRequest` API method must not be used inside the `OfferAppts` structure for an `sp:ApptOfferMultRequest` API method call.
	`</OfferAppts>`
	`<OfferCount>?</OfferCount>`
`</sp:ApptOfferMultRequest>`

All of the fields to do with dates and times are assumed to use customer local TZ, i.e. local to the region where the job is located.

The use of spares has not been validated for the Request Multi-Job Appointments SOAP API.

No special function is provided to book multiple appointments. Instead, the caller should iteratively book the set of offers for one operative returned from a call to ApptOfferMultRequest. The ID of the operative should be supplied as the ‘mandatory tech’ in the EmpID field of the SP_ApptBook struct parameter to each call of ApptBookRequest; the StdExtraDuration field can be set to SPSD_DurationOneDay for ‘all day’ jobs.