This B2B service allows you reserve or change an appointment against an order.
Related Business Process
BIC005: Reserve Appointment
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 | O | Appointment details for site visits. |
The following table provides details of the SiteVisit elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Unique identifier for the site visit. |
| type | O | Type of appointment. | |
| AppointmentSlot | Mandatory | I/O | Appointment Slot selected from the range provided by the Query Appointment Availability. |
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. |
The following table describes the AppointmentSlot elements.
| NAME | CARDINALITY I | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Appointment slot identifier. | |
| dateTime | Mandatory | I/O |
Anarrayofappointment startandenddatesand times. The start dates and times must be provided exactly as they were returned by the Query Appointment Availability Response. |
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].
ReserveAppointmentRequest
The following criteria is mandatory for requesting this service.
| INPUT | DESCRIPTION |
|---|---|
| Order id | Identifier of the related order |
| SiteVisit id | Identifier for the site visit returned by the Order Feasibility query. |
| SiteVisit type | Type of site visit that is required. |
| SiteVisit AppointmentSlot | The exact startDateTime and endDateTime returned by BIC004 Query Appointment Availability. |
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Request appointment reservation for a location. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Initiates a transaction to reservation an appointment. |
ReserveAppointmentResponse
If valid Order and Site Visit ids were provided, the response will contain the values used in the request and the following SiteVisit elements:
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgment. |
| Inputs | Response to your appointment reservation request. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Request appointment reservation is processed or has an exception. |