Product And Network Availability

Introduction

Use this API to choose an appropriate Broadband One product offering based on the access technologies and speeds available at a location or for a line.

To see how this API forms part of the wider Broadband One order process, click the diagram below.

This tutorial will show how to:

• Find the right Broadband One product offering, and
• For FTTP,  whether there's a usable data port on an existing optical network termination point at a location or co-located with a copper line.

Request Method & URI

POST https://api.wholesale.bt.com/hubco/tmf/productOfferingQualification/v4/productOfferingQualification

Request Entity-Body

Product availability checks can be made for a premises using an address key or the identity of a copper line located at a premises.

• For address based checks, A gold Openreach NAD key and district code is required (obtained via an address search). This is useful for new line provide scenarios and will indicate which technologies and speeds are likely for the location;
• For line based checks, a telephone number for an Openreach line (Directory Number) or access line ID is required (access line ids for lines can be found using a gold NAD key to check line availability). This is useful for stopped line starts, migrations between providers and/or product offerings on a copper line or for migration from copper to fibre. Line based checks provide additional copper line related information required for migration orders showing the migration scenario which applies (BTW ADSL to BTW SoGEA etc).

An address based check would use the following attributes (as an example)

{
  "@type": "btProductOfferingQualification",
  "instantSyncQualification": true,
  "productOfferingQualificationItem": [
    {
      "id": "74",
      "action": "add",
      "product": {
        "@type": "Product",
        "productOffering": {
          "id": "BroadbandOne",
          "@referredType": "btProductOfferingFamily"
        },
        "place": [
          {
            "id": "A90000423408",
            "districtId": "NI",
            "role": "install address",
            "@referredType": "btNADLocationReference"
          }
        ]
      },
      "@type": "btProductOfferingQualificationItem"
    }
  ],
  "provideAlternative": true,
  "provideOnlyAvailable": true,
  "provideUnavailabilityReason": false,
  "relatedParty": [ 
    {
        "id": "CUG5023768826",
        "role": "BtCug",
        "@type": "BTRelatedParty",
        "@referredType": "Customer"
    }

Response Entity-Body

This truncated response shows example FTTP and SOGEA options. Each available product offering (a combination of technology and speed) is shown individually with their respective attributes and characteristics.

FTTP productOfferingQualificationItem objects include optical network terminal (ONT) availability.

Below this you'll find an explanation of relevant attributes and characteristics which are relevant when placing the Broadband One order.

{
    "expirationDate": "2023-07-26T09:51:24.304Z",
    "instantSyncQualification": true,
    "productOfferingQualificationDate": "2022-11-05T18:18:24.304Z",
    "provideAlternative": true,
    "provideOnlyAvailable": true,
    "provideUnavailabilityReason": false,
    "qualificationResult": "qualified",
    "productOfferingQualificationItem": [
        {
            "id": "1",
            "product": {
                "place": [
                    {
                        "id": "A15104999999",
                        "role": "install address",
                        "@referredType": "btNADLocationReference"
                    }
                ],
                "productCharacteristic": [
                    {
                        "name": "AccessTechnology",
                        "value": "FTTP"
                    },
                    {
                        "name": "productHighDownloadSpeed",
                        "value": "147.2"
                    },
                    {
                        "name": "productLowDownloadSpeed",
                        "value": ""
                    },
                    {
                        "name": "productMinimumGuaranteedSpeed",
                        "value": "76"
                    },
                    {
                        "name": "productHighUploadSpeed",
                        "value": "27.6"
                    },
                    {
                        "name": "productLowUploadSpeed",
                        "value": ""
                    },
                    {
                        "name": "productMaximumUploadSpeed",
                        "value": ""
                    },
                    {
                        "name": "productMinimumUploadSpeed",
                        "value": ""
                    },
                    {
                        "name": "productMaximumDownloadSpeed",
                        "value": ""
                    },
                    {
                        "name": "productAdvertisedDownloadSpeed",
                        "value": "152"
                    },
                    {
                        "name": "productAdvertisedUploadSpeed",
                        "value": "28"
                    },
                    {
                        "name": "FTTPEXISTINGONTAVAILABLE",
                        "value": "N"
                    },
                    {
                        "name": "REASONCODE",
                        "value": "Z"
                    },
                    {
                        "name": "FTTPNEWONTAVAILABLE",
                        "value": "Y"
                    },
                    {
                        "name": "FTTPPriorityExchange",
                        "value": "N"
                    },
                    {
                        "name": "FTTPINSTALLPROCESS",
                        "value": "1 Stage"
                    },
                    {
                        "name": "FTTPCPTRANSFERORWLTOAVAILABLE",
                        "value": "Y"
                    }
                ],
                "productOffering": {
                    "id": "FTTP 160_30M",
                    "name": "FTTP"
                },
                "realizingResource": [
                    {
                        "id": "1",
                        "name": "ONT Data",
                        "value": {
                            "ONTREFNUMBER": "ONT0046482937",
                            "ONTFLOOR": "",
                            "ONTROOM": "",
                            "ONTPOSITION": "",
                            "BBUSTATUS": "Not Supplied",
                            "MAXSPEED": "Up to 1000",
                            "PORTLIST": {
                                "ONTPORT": [
                                    {
                                        "ONTPORTNUMBER": "1",
                                        "ONTPORTSTATUS": "Working",
                                        "ONTPORTTYPE": "Data",
                                        "VOICEWIRINGSTATUS": ""
                                    }
                                ]
                            }
                        },
                        "valueType": "object",
                        "@baseType": "ResourceRef",
                        "@type": "btONTResourceRef"
                    }
                ]
            },
            "@type": "btProductOfferingQualificationItem"
        },        {
            "id": "2",
            "product": {
                "place": [
                    {
                        "id": "A15104999999",
                        "role": "install address",
                        "@referredType": "btNADLocationReference"
                    }
                ],
                "productCharacteristic": [
                    {
                        "name": "AccessTechnology",
                        "value": "SOGEA"
                    },
                    {
                        "name": "productHighDownloadSpeed",
                        "value": "73.6"
                    },
                    {
                        "name": "productLowDownloadSpeed",
                        "value": "61.64"
                    },
                    {
                        "name": "productMinimumGuaranteedSpeed",
                        "value": "55.2"
                    },
                    {
                        "name": "productHighUploadSpeed",
                        "value": "18.4"
                    },
                    {
                        "name": "productLowUploadSpeed",
                        "value": "17.48"
                    },
                    {
                        "name": "productMaximumUploadSpeed",
                        "value": "18.99"
                    },
                    {
                        "name": "productMinimumUploadSpeed",
                        "value": "15.73"
                    },
                    {
                        "name": "productMaximumDownloadSpeed",
                        "value": "75.99"
                    },
                    {
                        "name": "productAdvertisedDownloadSpeed",
                        "value": "76"
                    },
                    {
                        "name": "productAdvertisedUploadSpeed",
                        "value": "19"
                    },
                    {
                        "name": "REASONCODE",
                        "value": "Z"
                    },
                    {
						"name": "AVAILABILITY_FLAG",
						"value": "Y"
					}
                ],
                "productOffering": {
                    "id": "SOGEA 80_20M",
                    "name": "SOGEA"
                }
            },
            "@type": "btProductOfferingQualificationItem"
        }
    ],
    "relatedParty": [
        {
            "id": "CUG5023769999",
            "role": "BtCug",
            "@type": "BTRelatedParty",
            "@referredType": "Customer"
        }
    ],
    "state": "done",
    "@type": "btProductOfferingQualification"
} 

Data from this response for placing an order

All access technologies

Migrations involving ADSL and FTTC

FTTP

The realizingResource array indicates working and spare ports on existing FTTP Optical Network Terminations (ONT) together with reference numbers..

Helpful values

Managed Install required?

FTTP

• No existing ONT, or no ports available on an existing ONT? You'll need to order a new or ONT - and a Managed Install.
• Otherwise - unless your end user requires installation/configuration support - the product can be self installed.

SOGEA/SOADSL

The line availability API indicates whether working or stopped lines (with their ids) are available to host a broadband product instance.

• Compatible line? Choose self install
• Otherwise, a new line is required  - and a Managed Install.

ADSL

Self install only.

Summary of Product Characteristic Names and Values

The following describes the product characteristics returned for various product offerings and possible values where there is an enumeration.

Reason Codes and Their Meaning

Other Broadband One tutorials

There are tutorials for every API leading to, and including, placing the order:

• Address management
• Product and network availability
• Appointment management
• Order management and progress updates

Additional support

• Broadband One Product Handbook (BT Wholesale login required)
• Reference documentation
• Product catalogue
• Knowledge centre