getAppointmentAvailabilities()

AppointmentAvailability getAppointmentAvailabilities(
 AppointmentAvailabilitiesRequest availabilitiesRequest)

This method returns list of appointment availabilities based on the request.

Parameters

availabilitiesRequest: Format: AppointmentAvailabilitiesRequest XML; Purpose: Defines a new AppointmentAvailabilitiesRequest XML document that specifies the appointment availabilities searching criteria.

Example: Search the availabilities of operators in a group

This example searches the availabilities of operators of a group.

<AppointmentAvailabilitiesRequest xmlns="http://xml.inomial.com/smile/2.xsd">
  <TicketGroupId>322</TicketGroupId> 
  <Start>2013-09-25T00:00:00+11:00</Start>
  <End>2013-09-25T23:59:59+11:00</End> 
  <Duration>1800000</Duration>
  <TravelDuration>60000</TravelDuration>  
</AppointmentAvailabilitiesRequest>

Results

This method returns an AppointmentAvailability XML document which lists the search result.

Faults

InvalidRequestException

This fault is returned when:

the specified USN is not a member of the specified group
neither USN or ticket group is provided
appointment duration is not provided or not a multiple of 1 minute
travel duration is negative or is not a multiple of 1 minute
start time is not provided
search end time is before the search start time

NoSuchItemException

This fault is returned when the specified USN is not an active subscription or group does not exist.

This error also occurs when there is no availability to return.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.GetAppointmentAvailabilities filename

filename: Purpose:Defines the filename of the AppointmentAvailabilitiesRequest XML document.

Note: For more information about the Java client and the options it accepts, see Java client syntax.