The following table describes the Filter - FilterParameter elements.
NAME | CARDINALITY I | INPUT/OUTPUT | DESCRIPTION |
---|
TimeSlot | Optional | I/O | Allows you to select a date range to limit returned appointment dates and times. |
VALIDATE_INTER_APPOINTMENT_LEADTIME | Optional | I/O | Flag allowing you to limit the appointment time slots returned for SiteVisits to those with a valid interappointment lead time. |
Order - SiteVisit - AppointmentSlot - Filter - FilterParameter - TimeSlot
The following table describes the values provided by the TimeSlot element.
Note: at least one TimeSlot value must be selected to enact this filter.
VALUE | DESCRIPTION |
---|
startDateTime | Start date for available appointment search. Note: if a date is not specified, the current date will be used. |
endDateTime | Enddateforavailableappointmentsearch. Note: if a date is not specified, the current date plus Default Advance Schedule Duration days will be used. The current setting for Default Advance Schedule Duration is 89 days. |
Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].
Order-SiteVisit-AppointmentSlot-Filter-FilterParameterVALIDATE_INTER_APPOINTMENT_LEADTIME
The following table describes the values provided by the VALIDATE_INTER_APPOINTMENT_LEADTIME element.
If this filter is not included in the request, the service will ignore the Inter-Appointment Leadtime rules and return all available appointments (this is the equivalent of selecting 'No').
VALUE | DESCRIPTION |
---|
Yes | AppointmentSlots returned will comply with inter-appointment lead time rules. |
No | AppointmentSlots returned ignore inter-appointment lead time rules. |