BT Wholesale Broadband One

BT Wholesale provide a fibre-based managed service called Broadband One (BB1) that offers access to FTTP, SoGEA, SOGFAST and SOADSL. Access to this service is via a REST API based on TMF622.

The Fibre Cafe has a connector to integrate with this API.

BTWHOLESALEBB1 Connector (Tenant API 1.7 / Tenant Updates API 1.5)

The initial connector was created for use with the Tenant API version 1.7 and the Tenant Updates API version 1.5

Authentication

OAuth 2.0 client credentials.

Retailer ID (OFCOM RID), Billing Account Number and Cug ID are required.

Address Search

This is not currently supported by the connector but will be soon.

Service Availability

BB1 requires NAD and DistrictCode rather than UPRN - plus also requires RoBT when placing the orders. To ensure the same availability request can be used for querying BT and AltNets, it is suggested to send all address identifiers in the request e.g.

{
  "identifier": {
    "id": "10091846447",
    "type": "UPRN",
    "additionalIdentifiers": [
      {
        "id": "A15104646284",
        "type": "NAD"
      },
      {
        "id": "LS",
        "type": "DistrictCode"
      },
      {
        "id": "R09598326361",
        "type": "ROBT"
      }
    ]
  }
}

Address information is not provided in the response.

Existing line information is provided including type (copper or fibre) and current status. Stopped lines will have a stopped date. For fibre lines, ONT information includes:

• ONT reference/ports
• Description (port type)
• Status (active or stopped)
• Location (floor/room/position)

The following information is not currently returned:

• Installation types
• Constraints
• ENNI and handover point location
• Service ready date

Where there is no availability, granular reason codes are not provided (OTHER will be used).

Appointing

When a managed install is required e.g. for a new line or ONT, appointment timeslots can be listed and reserved.

Timeslots are classified as weekday, saturday, sunday and AM/PM - standard/premium is not used. Expedited appointments and premium site visit reasons can not yet be specified.

Orders

The following service characteristics are required when placing orders:

• LINE_PROFILE : see below for values
• END _ USER _ TYPE : type of end user - Business or Residential
• CONTRACT_TERM : contract term in months

These service characteristics are optional according to the order:

• RETAILER_ID : unique identifier for the retailer provided by OFCOM
• MINIMUM_SPEED : requested guaranteed minimum speed (realtime)
• ECC_CHARGEBAND : Excess construction charges - see below for values
• TRC_CHARGEBAND : Time related charges - see below for values
• CARE_LEVEL : see below for values
• STATIC _ IP _ REQUESTED : number of static IP addresses required: 1, 2, 6
• DN _ PORT _ NUMBER : phone number to port (SOGEA)
• DN _ PORT _ DATETIME : date/time to port number (SOGEA)

Amendment and cancellation requests can be made for inflight orders. There are limitations to what amendments can be done with the BB1 API - the following are permitted:

• Change appointment
• Update contact details
• Update order notes
• Change to ECC CHARGEBAND or TRC CHARGEBAND characteristics

Line Profiles

For BB1, line profiles map directly to an underlying product as follows:

Excess Construction Charges

The default chargeband where not provided is 0.

Time Related Charges

The default chargeband where not provided is 0.

Care Levels

The default care level for SOGEA orders is 0; for FTTP orders is 1.

Order updates

BB1 provide the following service characteristics in KCIs:

• SERVICE_ID
• SERVICE _ ASSET _ ID
• CARE _ LEVEL _ ASSET _ ID
• STATIC _ IP _ ASSET _ ID
• DYNAMIC _ IP _ ASSET_ID

Supplier notes are attached to KCIs as received from BB1 (free text).

Asset Information

Asset information (UUIDs) will be returned as service characteristics in KCIs when you make an order. These must be persisted by the tenant alongside SERVICE_ID as they will be required when requesting future changes to the service.

For example, assuming a provide order has been placed at CARE_LEVEL 1, the following assets will have been created:

SERVICE_ASSET_ID=548a7b96-4c23-4ce3-b614-6c3f0f357b6d
CARE_LEVEL_ASSET_ID=a833c22c-35f3-4b2d-b5f0-e40db4f549bb

Later, a modify order must be created to move CARE_LEVEL from 1 to 2. The request must contain additional information including the active line profile, existing service asset id and existing care level asset id to be replaced:

LINE_PROFILE=123 action=NONE
SERVICE_ASSET_ID=548a7b96-4c23-4ce3-b614-6c3f0f357b6d action=NONE
CARE_LEVEL_ASSET_ID=a833c22c-35f3-4b2d-b5f0-e40db4f549bb action=DELETE
CARE_LEVEL=1 action=DELETE
CARE_LEVEL=2 action=ADD

As with the provide order, a KCI will give the new asset id for the chosen care level to again be stored:

CARE_LEVEL_ASSET_ID=4da8494c-1a34-41c7-a6b0-fe84795c2c13

For cease orders, the active line profile and existing service asset id must be provided, e.g.

LINE_PROFILE=123 action=NONE
SERVICE_ASSET_ID=548a7b96-4c23-4ce3-b614-6c3f0f357b6d action=NONE

Unsolicited reappoints

BT Wholesale (or downstream supplier) may on occasion re-appoint the order rather than request the tenant reappoints via an ACTION_REQUIRED : REAPPOINT KCI. This may be after direct interaction with the end customer.

In this scenario, this will come through as an unsolicited reappoint: INFORMATIONAL : REAPPOINTED.

The following fields will be in populated within the KCI order:

{
  "entity": {
    "appointmentSupplierReference": "123456543",
    "appointmentTimeslot": {
      "timeslotStartDateTime": "2022-01-10T08:00:00.000Z",
      "timeslotEndDateTime": "2022-01-10T13:00:00.000Z"
    }
  },
  "information": {
    "type": "REAPPOINTED"
  }
}

• appointmentSupplierReference - new appointment reference from the supplier
• appointmentTimeslot - new appointment timeslot

If this is not suitable then it can be treated as a REAPPOINT.

Notes:

Unsolicited Ceases are not currently sent via the BB1 API.