Return available appointment slots for a given service and address.

get/available-appointments

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

An address query parameter will be supplied specifying address ID and type along with the required serviceSpecification(s) as returned by the /service-availability endpoint.

All parameters are mandatory and will always be supplied by the gateway.

SecuritybearerAuth
Request
query Parameters
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 during this appointment

Example: serviceSpecification={"id":"ftthl2r"}
appointmentFromDate
string <date>

Find appointment slots from this date

Example: appointmentFromDate=2022-01-05
classifications
Array of strings (TimeslotClassification)

Find appointment slots only of these classification types (comma delimited list)

Items Enum: "WEEKDAY" "WEEKDAY_AM" "WEEKDAY_PM" "WEEKDAY_EARLY" "WEEKDAY_EVENING" "SATURDAY" "SATURDAY_AM" "SATURDAY_PM" "SATURDAY_EARLY" "SATURDAY_EVENING" "SUNDAY" "SUNDAY_AM" "SUNDAY_PM" "SUNDAY_EARLY" "SUNDAY_EVENING"
Example: classifications=WEEKDAY_AM,WEEKDAY_PM
appointmentPurpose
required
string (AppointmentPurpose)

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

Tenant
required
string

The tenant that has placed the request on the gateway

Example: TENANT1
Responses
200

Request successful - zero or more available appointments were returned

400

Bad request - supplied request was 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

Invalid or failed response from the supplier

503

Supplier API is temporarily unavailable

Response samples
application/json
{
  • "address": {
    • "id": "200004033694",
    • "type": "UPRN"
    },
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "FTTH"
    },
  • "availableTimeslots": [
    • {
      • "timeslotStartDateTime": "2022-01-10T09:00:00.000Z",
      • "timeslotEndDateTime": "2022-01-10T13:00:00.000Z",
      • "classification": "SATURDAY_AM",
      • "standard": true
      }
    ]
}