Broadband Checker Business API
Version History
Version 1.4
Released 11 October 2020
Added new hyperfibre fields. New fields included in this release:
| Method / Feature | Description |
|---|---|
| ponVariants: | A new Array of ponVariants that provides a list of different passive optical network speed variants available at a given location. Following are the elements in the array. |
| Speed = INTEGER (1000, 4000, 8000) | Indicates the PON speed available at the given address. |
| availabilityStatus: VARCHAR (Unplanned, Ready, Unknown, Under Build, Planned) | The status of the fibre roll out. If the status is equal to Ready then the address is Capable for a given PON Speed. |
| availabilityDate = DATE | Indicates the availability date for the relevant PON Speed at a given address |
| New Product added: | - Small Business Hyperfibre - Business Hyperfibre |
Version 1.3
Released DATE NEEDED
The Broadband Checker Business API version 1.3 adds 3 additional fields to the existing address information.
New fields included in this release:
| Method / Feature | Description |
|---|---|
| ffpID=STRING | Indicates the FFP a given Address is connected to. RSPs can use this information to determine which FFP a given address is connected to. |
| fibreUnbundlingEnabled=Y/N | Indicates if a given address is eligible for fibre unbundling. RSPs can use this information to determine if a given address can be unbundled. |
| fibreUnbundlingDate=DATE | Indicates the fibre unbundling date if a given address is eligible for fibre unbundling. RSPs can use this information to determine when a given address can be unbundled |
Version 1.2
Released DATE NEEDED
Features included in this release:
| Method / Feature | Description |
|---|---|
| Added the Small Business Fibre product | A new category of products called Small Business Fibre has been added to the existing list of products in the API. |
Version 1.1
Released DATE NEEDED
The Broadband Checker Business API version 1.1 adds 1 additional field with the recommendation of a connection and wiring field service for a VDSL capable line to achieve the VDSL speed benefits.
| Method / Feature | Description |
|---|---|
| premiseWiringRecommended=Y/N | Where the address is VDSL capable, this field will indicate whether a Connection and Wiring field service is strongly recommended to achieve the VDSL speed benefits. |
Version 1.0
Released DATE NEEDED
Features included in this release:
| Method / Feature | Description |
|---|---|
| GET services | Provides a set of information relating to current, available and future business broadband services. |
| GET product-features | Provides a set of information relating to all Product Features. |