Generic Supplier API

For suppliers that implement the Fibre Gateway Supplier API, this page details the functionality and changes to expect between different implementations.

Supplier API 1.9 / Supplier Updates API 1.5

This update extends on the previous service availability update to allow tenants to place 'swap' orders. This is where it is desired/required to replace or "regrade" an existing service with a new service for the current customer. This could be due to a change in access technology or perhaps an upgrade to the existing ONT to support additional line profiles.

A swap order works in a similar way to a new appointed provide order, but with the addition of the existing service identifier (SERVICE_ID) as a service characteristic.

Supplier API 1.8 / Supplier Updates API 1.4

Service Availability

This update introduces support for suppliers to return additional service information in the form of service characteristics in service availability queries. For example, this can be used to return which LINE_PROFILES are available for a given service at an address:

Copy
Copied
"serviceSpecifications": [
  {
    "id": "FTTP",
    "serviceCharacteristics": [
      {
        "name": "LINE_PROFILE",
        "values": [
          "1000/20",
          "2000/20",
        ]
      }
    ]
  }
]

This can prevent the need for a line profile catalogue as the tenant can dynamically retrieve what line profiles are available for a particular service at a given address.

This is particularly important for suppliers that offer different levels of service at each property. For example, an installed ONT may only be capable of supporting a 1G service so the only available LINE_PROFILE would be '1000/20' in the above example.

In addition to the above, where there are existing lines installed, the site information section can now be populated with characteristics to describe the existing service capabilities. This can include line bandwidth or other custom values - the currently recognised values are:

  • MIN _ DOWNSTREAM_MBPS
  • MAX _ DOWNSTREAM_MBPS
  • MIN _ UPSTREAM_MBPS
  • MAX _ UPSTREAM_MBPS

Appointing

The appointing process has been extended to allow for the tenant to specify new appointment purposes: REPAIR and MODIFY. MODIFY can be used to indicate that the appointment is for a change to an existing service rather than a new service. REPAIR is used to indicate that the appointment is to fix a fault on an existing service - related to T2R support below.

T2R Support

The T2R (Trouble To Resolve) order journey is now supported on the supplier API. This allows tenants to raise requests to perform service tests and diagnostics on an existing service, plus trouble tickets where necessary. Full details of T2R are now available on the portal - visit the T2R section in the left hand navigation.

Supplier API 1.7 / Supplier Updates API 1.3

This update brings the Supplier API in line with the latest Tenant API and allows the supplier to specify existing lines/ONTs with details of port status, further descriptions, location attributes, etc. The full switch, transfer and takeover order journeys will be supported.

The Supplier Updates API includes the ability to send unsolicited cease notifications.

Supplier API 1.6 / Supplier Updates API 1.2

The initial release of the supplier API focuses on NEW provide orders only. Whilst the API allows for returning lineType to specify NEW vs START/TAKEOVER lines and existing ONTs, this was not fully implemented due to lack of support by the initial AltNet implementations.

Unsolicited cease notifications are also not yet supported.

This section details onboarded suppliers and any notes/limitations for individual implementations.

Service Availability

Supplier Address Information Site Information Constraints/UnavailabilityReasons
Freedom Fibre None Populated for NEW lines where a service can be installed - installationType:STANDARD and enniId supplied only Not available
Community Fibre Some information Not currently populated - a CR has been requested Not available

Appointing

Supplier Timeslots Premium Supplier Ref
Freedom Fibre Weekday/Saturday + AM/PM N/A Yes
Community Fibre Weekday/Saturday + AM/PM N/A Yes

Orders

Supplier Service Specifications Required Service Characteristics Engineer Tasks Provided Service Characteristics Supplier Ref
Freedom Fibre FTTH, FTTB LINE_PROFILE
AUTHENTICATION_AGENT
REMOTE_ID
INSTALL_ROUTER
TEST_SINGLE_DEVICE
SERVICE_ID
ONT_REFERENCE
ONT_SERIAL_NUMBER
Yes
Community Fibre FTTH LINE_PROFILE
REMOTE_ID
ADDITIONAL_CABLING
TEST_MULTIPLE_DEVICES
INSTALL_BBU
SERVICE_ID
ONT_REFERENCE
SERVICE_VLAN_ID
Yes

The available values will vary according the tenant to supplier agreement.