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.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.
Supplier API 1.7 / Supplier Updates API 1.3
This forthcoming update will bring the Supplier API in line with the latest Tenant API and allow the suppler 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 will include the ability to send unsolicited cease notifications.