Reserve a previously returned appointment slot.

post/appointments

This endpoint can be called to reserve an appointment with a supplier to install or maintain service(s) at a given address.

Details of a previously returned available appointment must be provided to be reserved according to the supplier reservation policy. Where the reservation has a TTL (time to live) before being released, the expiry time will be stated.

The returned reservation ID must be sent as part of the order at which point it should be considered confirmed.

Securityoauth2
Request
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

Request Body schema: application/json
supplier
required
string^\w{1,20}$

System identifier for a supplier on the gateway that is associated with this appointment

required
object (AddressIdentifier)

Address identifier for location including type of identifier.

required
object (ServiceSpecification)

Details of a service the supplier provides at the selected address.

purpose
required
string^\w{1,20}$

Purpose of the appointment e.g. PROVIDE

required
object (Timeslot)

Represents an appointment timeslot with a supplier.

Responses
201

Operation successful - appointment was reserved. Returned ID to be used when placing order

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

Unexpected Fibre Gateway error

502

Invalid response from the supplier

503

Fibre Gateway is temporarily unavailable

504

Timeout or no response from the supplier

Request samples
application/json
{
  • "supplier": "SUPPLIER1",
  • "address": {
    • "id": "A00000031882",
    • "type": "NAD",
    • "additionalIdentifiers": [
      • {
        • "id": "A00000031882",
        • "type": "NAD"
        }
      ]
    },
  • "serviceSpecification": {
    • "id": "ftthl2r"
    },
  • "purpose": "PROVIDE",
  • "timeslot": {
    • "timeslotStartDateTime": "2022-01-10T09:00:00.000Z",
    • "timeslotEndDateTime": "2022-01-10T13:00:00.000Z"
    }
}
Response samples
application/json
{
  • "id": 345,
  • "supplierReference": "123456543",
  • "expiryDateTime": "2022-01-01T13:45:00.000Z",
  • "supplier": "SUPPLIER1",
  • "address": {
    • "id": "A00000031882",
    • "type": "NAD",
    • "additionalIdentifiers": [
      • {
        • "id": "A00000031882",
        • "type": "NAD"
        }
      ]
    },
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "A123X-1"
    },
  • "purpose": "PROVIDE",
  • "timeslot": {
    • "timeslotStartDateTime": "2022-01-10T09:00:00.000Z",
    • "timeslotEndDateTime": "2022-01-10T13:00:00.000Z",
    • "classification": "SATURDAY_AM",
    • "standard": true
    }
}