This B2B service allows you to check the available of Appointment Time Slots for an order.
Related Business Process
BIC004: Query Appointment Availability
Related Products
This service is available for fibre products.
The data elements and attributes that may be used by this service are described below.
The order elements contain Order header information. The following table describes the Order elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Order identifier. |
| type | O | Type of order. | |
| SiteVisit | Mandatory | I/O | Appointment details. |
The following table describes the SiteVisit elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Conditional | I/O | Unique identifier for a site visit |
| type | Conditional | I/O | Type of appointment. |
| AppointmentSlot | Optional | I/O | An array of appointment start and end dates and times. |
The following table describes the values provided by the type element.
| VALUE | DESCRIPTION |
|---|---|
| Scope | Site visit for scoping. |
| Install | Site visit for Installation. |
| Install/CSE | Site visit for Installation and Customer Service Experience. |
| CSE | Site visit for Customer Service Experience. |
| CONNECT_RFS_DATE_TIME | Service connection dates. |
| DISCONNECT_RFS_DATE_TIME | Service disconnection dates. |
The following table describes the AppointmentSlot elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| dateTime | O | Anarrayofappointment startandenddatesand times. | |
| Filter | Optional | I/O |
Allows you to restrict your search criteria to range of appointment time slots. The search criteria is not saved, and will apply only to the requesting instance. |
The following table describes the values provided by the dateTime element.
| VALUE | DESCRIPTION |
|---|---|
| startDateTime | Start date and time. |
| endDateTime | End date and time. |
Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].
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. |
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].
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. |
QueryAppointmentRequest
The following criteria is mandatory for requesting this:
| APPOINTMENT TYPE | INPUT CRITERIA | NOTE |
|---|---|---|
| SiteVisit |
|
TheSiteVisit type must not be included in requests for site visit appointments. |
| RFS date |
|
Valid SiteVisit type values are:
|
You may restrict the search criteria to a date range using the following the FilterParameter elements:
Note: if the filter is not selected the maximum range of available appointment slots will be returned using current date plus Default Advance Schedule Duration number of days.
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Query appointment availability for a location. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Initiates a transaction to query appointment availability. |
QueryAppointmentResponse
If valid Order and SiteVisit details were provided, the response will contain the values used in the request and the range of available time slots using the SiteVisit elements:
startDateTime
Appointments are either dates and times a site visit can be performed, e.g. Scope, Install, Install/CSE or CSE or as available RFS dates.
Site visit appointments are returned as morning slots from 08:00 - 12:00 and afternoon slots from 13:00 - 17:00, RFS dates are returned on the hour.
The following tables provide examples of the values.
Morning Site Visit:
| ELEMENT | VALUE |
|---|---|
| startDateTime | 2015-09-29T08:00:00+13:00 |
| endDateTime | 2015-09-29T12:00:00+13:00 |
Afternoon Site Visit:
| ELEMENT | VALUE |
|---|---|
| startDateTime | 2015-09-29T13:00:00+13:00 |
| endDateTime | 2015-09-29T17:00:00+13:00 |
RFS dates:
| ELEMENT | VALUE | EXAMPLE |
|---|---|---|
| startDateTime | [Time on the hour] | 2015-12-15T10:00:00.000+13:00 |
| endDateTime | [Start time + 59M.59S] | 2015-12-15T10:59:59.000+13:00 |
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your query of appointment availability for a location. |
| Outputs | Synchronous Acknowledgement |
| Non-repudiation | Yes. |
| Description | Query appointment availability is processed or has an exception. |