Skip to content
Service Availability/
Return available services...

Fibre Cafe : Supplier API (1.15)

Introduction

The Fibre Cafe is a scalable, unified platform to support L2C provisioning, in-life modification/cease and T2R trouble resolution between communication providers (CP) and network operators or aggregators.

CPs are known as 'tenants' on the Fibre Cafe and communicate with the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers' and provide the Supplier API.

Each supplier is responsible for implementing this southbound API specification for the Fibre Cafe to retrieve available services and support appointing and order management.

Note: Order updates (KCIs) must be sent to the Supplier Updates API hosted by the Fibre Cafe. __

© 2022-2026 Strategic Imperatives

Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://api.provided_by_supplier.net

Service Availability

Retrieve what services (if any) the supplier has available for a given address.

This follows the concepts in TMF645 - Service Qualification API and TMF673 - Address Management API.

Operations

Return available services for given address.

Request

This endpoint is called to find what services are available at a given address with a supplier.

An address query parameter will be supplied specifying address ID and type.

All parameters are mandatory and will always be supplied by the Fibre Cafe.

Security
oauth2
Query
addressobjectrequired

Address identifier of provided type e.g. UPRN to check for service availability

Example: address={"id":"200004033694","type":"UPRN"}
address.​idstringrequired

Address identifier of provided type e.g. UPRN

Example: "200004033694"
address.​typestringrequired

Type of addressId provided e.g. UPRN

Example: "UPRN"
serviceTypesArray of strings(ServiceTypeList)non-empty

If specified, filter the service availability check to only include the specified service type(s)

Default ["BROADBAND"]
Items Enum"BROADBAND""ETHERNET"
Example: serviceTypes=BROADBAND&serviceTypes=ETHERNET
Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Tenantstringrequired

The tenant that has placed the request on the Fibre Cafe

Example: TENANT1
curl -i -X GET \
  'https://api.provided_by_supplier.net/service-availability?address={%22id%22%3A%22200004033694%22%2C%22type%22%3A%22UPRN%22}&serviceTypes=BROADBAND%2CETHERNET' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Tenant: TENANT1' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string'

Responses

Request successful - zero or more services were returned

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
addressobject(Address)required

Address for location associated with the service order.

address.​identifierobject(AddressIdentifier)required

Address identifier for location including type of identifier.

address.​identifier.​idstringrequired

Address identifier of provided type e.g. UPRN

Example: "200004033694"
address.​identifier.​typestringrequired

Type of addressId provided e.g. UPRN

Example: "UPRN"
address.​namestring[ 1 .. 50 ] charactersread-only

Identifying name of the sub unit

Example: "TWENTY"
address.​streetNumberstring[ 1 .. 50 ] charactersread-only

Discriminator used to identify the property on a street

Example: "20"
address.​streetNamestring[ 1 .. 50 ] charactersread-only

Name used to identify the street

Example: "Kingston Road"
address.​localitystring[ 1 .. 50 ] charactersread-only

Name used to identify the area

address.​citystring[ 1 .. 50 ] charactersread-only

Name used to identify the town or city

Example: "Staines-Upon-Thames"
address.​postcodestring[ 1 .. 12 ] charactersread-only

Postal code

Example: "TW184LG"
address.​countrystring[ 1 .. 50 ] charactersread-only

Name used to identify the country

Example: "UK"
address.​subAddressobject(SubAddress)read-only

More specific definition of a property within an urban area.

serviceSpecificationsArray of objects(ServiceSpecificationAvailability)>= 0 itemsrequired

List of services that are available at this address

serviceSpecifications[].​idstring[ 1 .. 50 ] charactersrequired

Unique identifier for this service specification (if available)

Example: "ftthl2r"
serviceSpecifications[].​namestring[ 1 .. 50 ] charactersread-only

Name of the service

Example: "FTTH"
serviceSpecifications[].​serviceCharacteristicsArray of objects(ServiceCharacteristicAvailability)

Service characteristics supported by this service

siteInformationobject(SiteInformation)

Describes site installation details and any constraints that may apply, along with any existing lines.

unavailabilityReasonsArray of objects(UnavailabilityReason)>= 0 items

Where there is no availability, provides the reason(s)

Response
application/json
{
  "address": {
    "identifier": { … },
    "name": "TWENTY",
    "streetNumber": "20",
    "streetName": "Kingston Road",
    "locality": "string",
    "city": "Staines-Upon-Thames",
    "postcode": "TW184LG",
    "country": "UK",
    "subAddress": { … }
  },
  "serviceSpecifications": [
    { … }
  ],
  "siteInformation": {
    "newLine": true,
    "installationType": "STANDARD",
    "constraints": [ … ],
    "serviceReadyDate": "2022-01-01",
    "enniId": "S1889",
    "siteName": "string",
    "siteLocation": "string",
    "lineCharacteristics": [ … ],
    "existingLines": [ … ]
  },
  "unavailabilityReasons": [
    { … }
  ]
}

Quote Management

Create and manage a quote to provide service at requested sites. This follows the concepts in TMF648 - Quote Management API.

Operations

Appointment Management

Retrieve and reserve appointments for installing a service at a given address.

This follows the concepts in TMF646 - Appointment API.

Operations

Order Management

Create and manage an order to provide, cease or modify a service at a given address.

This follows the concepts in TMF641 - Service Ordering Management API.

Operations

Service Test Management

Handle a request to perform a service test on a given active line/service.

Operations

Service Problem Management

Create and manage a service problem for a given line/service.

Operations