Feedback

Fibre Ordering

BIC004: Query Appointment Availability

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. BIC004: Query Appointment Availability
Back

Name

Customer Request Appointment Availability

Description

This process provides you with the ability to retrieve the available Appointment Time Slots for an order.

Related B2B Services

Preceded by

Succeeded by

Flow - Customer Requests Appointment Availability

bic004

Process Pre-conditions

If you are using query to retrieve an appointment for an order that you:

Process Post-conditions

You receive a response containing a range of available Appointment Time Slots.

If you used this query to retrieve a appointment for an order that you:

Basic Path

STEP DESCRIPTION ROLE
1 Submit request for Site Visit or RFS appointments. Customer
2 Process the request and generate the available Appointment Time Slots. If the Appointment Time Slots cannot be generated or the input information is invalid, refer to alternate flow 1. Chorus
3 Return a range of Appointment Time Slots. Chorus
4 Receive the range of Appointment Time Slots. Customer

Alternate Flow 1

STEP  DESCRIPTION ROLE
2.1 If the Appointment Availability request is invalid, return an error response. Chorus
2.2 Return an error response explaining the Appointment Availability query cannot be completed. Chorus

Refer to the Exception Codes table for error details.

Business Rules

Input Date Validation

The dates submitted as search criteria must meet the following criteria:

  • Requested appointment start date must be greater than the current date.
  • Requested appointment start time must be greater than the current time (+30 minutes)
  • Requested appointment end date:
  1. Must be greater than the appointment start date and,
  2. Less than or equal to the number of days set by the Default Advance Schedule Duration days.

Note: the Default Advance Schedule Duration is currently set to 89 days.

Update Existing Appointment Costs

Appointments rescheduled after 3pm, during the business day before they due to commence, may be subject to additional charges.

Calculating Lead-time

The service will return available AppointmentTimeSlots asa morning oran afternoon slot. The dates, where appointments are available, will begin:

  • the following business day, if the request is submitted during business hours.
  • the second business day, if the request is submitted out of business hours, e.g. weekends, holidays or after 5pm during a business day.

The following table shows the appointment types and the associated Lead-times.

APPOINTMENT TYPE OTHER ACTICE APPOINTMENTS OFFER TYPE ADDITIONAL LEAD TIME INTER-APPOINTMENT LEAD TIME NOTES
Scope N/A Residential (default) 1 day 3 days or more

Example:

Scope (Day 1)

Install (Day 4).
Install (or Install + CSE) Scope Residential (default) 1 day 3 days or more

Example:

Scope (Day 1)

Install (Day 4).
Install (or Install + CSE) None Residential (default) 4 days N/A

Example:

Install (Day 4).
CSE (standalone) N/A Residential (default) 2 days N/A

Example:

CSE (Day 2).

Scope

 N/A

Business or Educational 

 1 day 5 days or more

Example:

Scope (Day 1)

Install (Day 6).
Install (or Install + CSE) Scope Business or Educational Scope 5 days or more

Example:

Scope (Day 1)

Install (Day 6).
Install (or Install + CSE) None Business or Educational 6 days N/A

Example:

Install (Day 6).
CSE (standalone) N/A Business or Educational 2 days N/A  

Exception Codes

The Exception Codes table lists the exceptions that may be returned by this service.

For a full list of exception codes and their meanings see B2B Exception Codes.

EXCEPTION CODE EXCEPTION CODE MESSAGE
000 Backendprocessingerrorencountered-Ifproblem persistspleasecontact Chorus admin
015 Site Visit ID not found
016 DateTime Range not valid
017 RFS validation failed: {%s}
019 Customer Order ID or Customer Reference ID not found
029 The Order State of the specified Customer Order does not support the selected action
030 The Order ID provided belongs to a different customer
031 Site Visit request failed: {%s}
040 Request for RFS date contains sitevisitID
041 Request for RFS date contains invalid RFS date type

Use Cases

The following table describes the use cases that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO DESCRIPTION QUERY REQUEST QUERY RESPONSE
Customer Queries Appointment Availability - to retrieve site visit appointments Query Appointment Availability is executed to retrieve available site visit appointments for an order that has not been created, using the Order id and the SiteVisit id.
  • Order id
  • SiteVisit id
  • Order id
  • SiteVisit id
  • SiteVisit type
  • AppointmentSlot
  • startDatetime
  • endDatetime

Note: Appointment slots are between the current date and the end of the period set by the Default Advanced Schedule Duration, regardless of the Inter-Appointment Leadtimes.
Customer Queries Appointment Availability to retrieve RFS appointments Query Appointment Availability is executed to retrieve available RFS date appointments for an existing order, using the Order id and SiteVisit type.
  • Order id
  • SiteVisit id
  • Order id
  • SiteVisit id
  • SiteVisit type
  • AppointmentSlot
  • startDatetime
  • endDatetime
Customer Queries Appointment Availability - with TimeSlot filter Query Appointment Availability is executed to retrieve available site visit appointments for an order that has not been created, using the Order id, the SiteVisit id and the TimeSlot FilterParameter.
  • Order id
  • SiteVisit id
  • FilterParameter
  • Order id
  • SiteVisit id
  • SiteVisit type
  • AppointmentSlot
  • startDatetime
  • endDatetime

Note: Appointment slots are between the dates selected using the filter, regardless of the Inter-Appointment Lead-times.
Customer Queries Appointment Availability - with TimeSlot and VALIDATE_INTER_APPOINTMENT_LEADTIME - Yes filter Query Appointment Availability is executed to retrieve available site visit appointments for an order that has not been created, using the Order id, the SiteVisit id and the TimeSlot and VALIDATE_INTER_APPOINTMENT_LEADTIME FilterParameters.
  • Order id
  • SiteVisit id
  • FilterParameter
  • Order id
  • SiteVisit id
  • SiteVisit type
  • AppointmentSlot
  • startDatetime
  • endDatetime
Note: Appointment slots comply with the InterAppointment Lead-times.

Use Case Exceptions

The following table describes the use case exceptions that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO DESCRIPTION QUERY REQUEST QUERY RESPONSE
Customer Queries Appointment Availability - backend processing error occurs Query Appointment Availability is executed to check available appointments times and dates. Backend processing error occurs.
  • Order id
  • SiteVisit id
  • Order id
  • SiteVisit id
  • Exception message
Customer Queries Appointment Availability - SiteVisit id is not found Query Appointment Availability is executed to check available appointments times and dates. The Site Visit id is not found.
  • Order id
  • SiteVisit id
  • Order id
  • SiteVisit id
  • Exception message
Customer Queries Appointment Availability - dateTime range not valid Query Appointment Availability is executed to check available appointments times and dates. The date range is invalid.
  • Order id
  • SiteVisit id
  • FilterParamter
  • SiteVisit id
  • TimeSlot
  • startDatetime
  • endDatetime
  • Exception message
Customer Queries Appointment Availability - Order id belongs to a different customer

Query Appointment Availability is executed to check available appointments times and dates.

The Order id provided belongs to a different Customer.
  • Order id
  • SiteVisit id
  • Order id
  • SiteVisit id
  • Exception message
Customer Queries Appointment Availability- site visit request contains SiteVisit type Query Appointment Availability is executed to check available Scope appointments dates. The request for site visit appointments includes the SiteVisit type field.
  • Order id
  • SiteVisit id
  • SiteVisit type
  • Order id
  • SiteVisit id
  • SiteVisit type
  • Exception message
Customer Queries Appointment Availability - RFS date request contains SiteVisit id Query Appointment Availability is executed to check available RFS dates. The request for RFS dates includes the SiteVisit id field.
  • Order id
  • SiteVisit id
  • SiteVisit type
  • Order id
  • SiteVisit id
  • SiteVisit type
  • Exception message

Success Criteria

Query Appointment Availability Request and Response Success Criteria

This section provides a list of the User Story References that we have met in this business process, as defined by the Ultra-Fast Broadband BSS / OSS Business Interaction Framework.

The document is available from:

Refer to the TCF website for documentation.

ID DESCRIPTION
US43 As a Service Provider, I want to be able to book an appointment for when the LFC is going to perform a site visit so that I can inform the Customer that they need to be at home on that day.
SC43.03 The Service Provider can view Appointment TimeSlots in the response of a Query Appointment Request.
SC43.04 The Service Provider can view Appointment TimeSlots after the service request is created.
SC43.05 The Service Provider can view available Appointment TimeSlots and is allowed to book Appointment TimeSlots by specifying an Appointment TimeSlot value that is returned in the response.