Return available appointment slots for a given service and address.

This endpoint can be called to find what appointments a supplier has available to install service(s) at a given address.

An address query parameter must be supplied specifying address ID and type along with the required service specification as returned by the /service-availability endpoint.

The next available appointments after the appointmentStartDate will be returned - a suitable date should be chosen based on installationLeadTime if this was provided during availability check.

Appointment slots are classified based on day as weekday or saturday/sunday and by time to day, AM/PM or early morning/evening. Based on the tenant-supplier agreement, some of these classifications will be considered premium.

This request will be routed to a particular supplier which must be specified.

Securityoauth2
Request
query Parameters
supplier
required
string

System identifier for a supplier on the gateway

Example: supplier=DUMMY_SUPPLIER
required
object

Address identifier of provided type e.g. UPRN to check for appointment availability

Example: address={"id":"200004033694","type":"UPRN"}
required
object

The service to be installed or maintained during this appointment

Example: serviceSpecification={"id":"ftthl2r"}
Array of objects (ServiceCharacteristic)

Characteristics of the service to be maintained during this appointment e.g. SERVICE_ID, CARE_LEVEL

appointmentFromDate
string <date>

Find appointment slots from this date

Example: appointmentFromDate=2022-01-05
standardOnly
boolean
Default: false

Find appointment slots classified as standard only (exclude premium time slots)

singleDayAppointment
boolean
Default: false

Find only appointment slots that start/end on the same day

appointmentPurpose
required
string

Purpose of the appointment : PROVIDE, REPAIR, MODIFY

Example: appointmentPurpose=PROVIDE
header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Responses
200

Request successful - zero or more available appointments were returned

400

Bad request - supplied parameters were malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

502

Invalid response from the supplier

503

Fibre Gateway is temporarily unavailable

504

Timeout or no response from the supplier

get/available-appointments
Response samples
application/json
{
  • "supplier": "SUPPLIER1",
  • "address": {
    • "id": "A00000031882",
    • "type": "NAD",
    • "additionalIdentifiers": [
      • {
        • "id": "A00000031882",
        • "type": "NAD"
        }
      ]
    },
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "A123X-1"
    },
  • "availableTimeslots": [
    • {
      • "timeslotStartDateTime": "2022-01-10T09:00:00.000Z",
      • "timeslotEndDateTime": "2022-01-10T13:00:00.000Z",
      • "classification": "SATURDAY_AM",
      • "standard": true
      }
    ]
}