Return available services for a given address.

get/service-availability

This endpoint can be called to find what services are available at a given address.

An address query parameter must be supplied specifying address ID and type as described above.

If required, a particular supplier or list of suppliers can be specified in the request; otherwise the gateway will check with all suppliers as configured for the tenant.

Securityoauth2
Request
query Parameters
required
object

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

Example: address={"id":"200004033694","type":"UPRN"}
suppliers
Array of strings (SupplierList) non-empty

If specified, the request will be sent only to the specified supplier(s)

Example: suppliers=SUPPLIER1&suppliers=SUPPLIER2
postalCode
string

If specified, allows the gateway to restrict calls to supplier(s) operating within a postal code region

header Parameters
X-Request-ID
required
string

Unique identifier to link request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Responses
200

Request successful - zero or more services were returned

400

Bad request - supplied parameters were malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Response samples
application/json
[
  • {
    • "supplier": "SUPPLIER1",
    • "address": {
      • "identifier": {
        • "id": "A00000031882",
        • "type": "NAD",
        • "additionalIdentifiers": [
          • {
            • "id": "A00000031882",
            • "type": "NAD"
            }
          ]
        },
      • "name": "TWENTY",
      • "streetNumber": "20",
      • "streetName": "Kingston Road",
      • "locality": "string",
      • "city": "Staines-Upon-Thames",
      • "postcode": "TW184LG",
      • "country": "UK",
      • "subAddress": {
        • "name": "Strategic Imperatives",
        • "unitNumber": "Floor 3"
        },
      • "qualifier": "Gold",
      • "source": "OPENREACH",
      • "additionalAttributes": [
        • {
          • "name": "UNINHABITED",
          • "value": "true"
          }
        ]
      },
    • "serviceSpecifications": [
      • {
        • "id": "ftthl2r",
        • "name": "FTTH",
        • "serviceCharacteristics": [
          • {
            • "name": "LINE_PROFILE",
            • "values": [
              • "100/20"
              ]
            }
          ]
        }
      ],
    • "siteInformation": {
      • "line": {
        • "type": "NEW",
        • "lineType": "FIBRE",
        • "constraints": [
          • {
            • "code": "WAYLEAVE_SHARED",
            • "text": "string"
            }
          ],
        • "enniId": "S1889",
        • "siteName": "string",
        • "siteLocation": "string",
        • "installationType": "STANDARD",
        • "lineCharacteristics": [
          • {
            • "name": "DOWNSTREAM_BANDWIDTH",
            • "value": "68700"
            }
          ]
        },
      • "existingLines": [
        • {
          • "enniId": "S1889",
          • "siteName": "string",
          • "siteLocation": "string",
          • "installationType": "STANDARD",
          • "lineCharacteristics": [
            • {
              • "name": "DOWNSTREAM_BANDWIDTH",
              • "value": "68700"
              }
            ],
          • "lineType": "COPPER",
          • "lineId": "OHP5738089O3",
          • "status": "ACTIVE",
          • "tenantActive": false,
          • "productType": "SOGEA",
          • "stoppedDate": "2022-01-01T13:45:00.000Z"
          }
        ],
      • "serviceReadyDate": "2022-01-01"
      }
    }
]