Return available services for given address.

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 gateway.

SecuritybearerAuth
Request
query Parameters
required
object

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

Example: address={"id":"200004033694","type":"UPRN"}
header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Tenant
required
string

The tenant that has placed the request on the gateway

Example: TENANT1
Responses
200

Request successful - zero or more services were returned

400

Bad request - supplied request was 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

Invalid or failed response from the supplier

503

Supplier API is temporarily unavailable

get/service-availability
Response samples
application/json
{
  • "address": {
    • "identifier": {
      • "id": "200004033694",
      • "type": "UPRN"
      },
    • "name": "TWENTY",
    • "streetNumber": "20",
    • "streetName": "Kingston Road",
    • "locality": "string",
    • "city": "Staines-Upon-Thames",
    • "postcode": "TW184LG",
    • "country": "UK",
    • "subAddress": {
      • "name": "Strategic Imperatives",
      • "unitNumber": "Floor 3"
      }
    },
  • "serviceSpecifications": [
    • {
      • "id": "ftthl2r",
      • "name": "FTTH"
      }
    ],
  • "siteInformation": {
    • "newLine": true,
    • "installationType": "STANDARD",
    • "constraints": [
      • {
        • "code": "WAYLEAVE_SHARED",
        • "text": "string"
        }
      ],
    • "serviceReadyDate": "2022-01-01",
    • "enniId": "S1889",
    • "siteName": "string",
    • "siteLocation": "string",
    • "existingLines": [
      • {
        • "enniId": "S1889",
        • "siteName": "string",
        • "siteLocation": "string",
        • "installationType": "STANDARD",
        • "ont": {
          • "ontReference": "ONT0000123123",
          • "serialNumber": "1234567890",
          • "manufacturer": "Nokia",
          • "floor": "1",
          • "room": "Reception",
          • "position": "string",
          • "ports": [
            • {
              • "portNumber": 2,
              • "description": "Data",
              • "status": "ACTIVE",
              • "tenantActive": false,
              • "stoppedDate": "2022-01-01T13:45:00.000Z"
              }
            ]
          },
        • "lineId": "OHP5738089O3",
        • "lineCharacteristics": [
          • {
            • "name": "DOWNSTREAM_BANDWIDTH",
            • "value": "68700"
            }
          ]
        }
      ]
    },
  • "unavailabilityReasons": [
    • {
      • "code": "OUT_OF_OPTIC_RANGE",
      • "text": "string"
      }
    ]
}