Return available ethernet services for a given address.

get/ethernet-availability

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

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

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 link 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

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",
      • "serviceCharacteristics": [
        • {
          • "name": "LINE_PROFILE",
          • "values": [
            • "100/20"
            ]
          }
        ]
      }
    ],
  • "onts": [
    • {
      • "lineType": "FIBRE",
      • "ontReference": "ONT0000123123",
      • "ontSerialNumber": "1234567890",
      • "ontManufacturer": "Nokia",
      • "ontFloor": "1",
      • "ontRoom": "Reception",
      • "ontPosition": "string",
      • "ports": [
        • {
          • "portNumber": 2,
          • "description": "Data",
          • "status": "ACTIVE",
          • "tenantActive": false,
          • "stoppedDate": "2022-01-01T13:45:00.000Z"
          }
        ]
      }
    ]
}