Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SCHUD and version 9.3
Panel

The sp:ApptOfferMultRequest API method can be used to request possible multi-job appointments (i.e. for jobs that will require multiple appointments to complete).


 

Description

The sp:ApptOfferMultRequest API method 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
  • the input parameter RequestInfo provides the criteria which apply
to
  • to all
of
  •  of the individual requests which make up the multi-job appointment request;
The
  • the input parameter Request provides the criteria
for
  • for each
of
  •  of the appointment requests making up the multi-job appointment request; and
The
  • the output parameter
,
  • Offers
, contains
  •  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

Book Appointment SOAP API, 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)

the Request Appointments SOAP API, except where specified.

Panel

On This Page:

Definition

Return Structure

  • Return Codes
  • Panel

    Related Pages:

     

    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 Standard Return Codes, the possible Return Codes from this API are:

    Include Page
    _API ApptOfferMultRequest Return Codes
    _API ApptOfferMultRequest Return Codes