Skip to content

ISP Endpoints

ISPs are able to perform verification of customers' OAIDs and coverage of access nodes by calling the corresponding endpoints in the ISP API. Details for checking this information with the API are provided below.

OAID

Read OAID

Authorized users can make requests to the API to check the existence of an OAID at the endpoint "Read OAID". To do this, directly specify the OAID in the path.

$ curl --request GET "https://api.oaid.at/v2/isp/codes/AB1C23E4/" \
$  --header "Authorization: Bearer <access_token>" \
$  --header "Accept: application/json"
---> 100%
{
  "oaid": "AB1C23E4",
  "token": "requested",
  "status": "active",
  "version": "v8",
  "created_at": "2022-03-01T10:35:03.392+01:00",
  "modified_at": "2022-03-01T10:37:01.012+01:00"
}

Coverage

Search CANs

A feasibility check can be performed by calling the "Search CANs" endpoint on a specific coordinate.

This pulls up a list of all Customer Access Nodes (CANs) within a user-specified range (query parameter: radius) from the coordinate (parameter: center). By default, the radius is set to 100 meters.

The endpoint consists of the following query parameters (required ones are in bold, while optional are in italics):

  • 'center': the coordinates
  • 'radius': distance (in meters) to search from the center coordinate for CAN
  • 'token': options are: "planning", "construction", or "operation"
  • 'technology': coverage type options are: "FTTB", "FTTH", "FTTC", "DOCSIS", "FWA", or "DSL" (will be usable in the near future)
$ curl --request GET "https://api.oaid.at/v2/isp/coverage/?center=48.3,16.0&radius=50" \
$  --header "Authorization: Bearer <access_token>" \
$  --header "Accept: application/json" 
---> 100%
[
    {
      "node_type": "geo",
      "token": "construction",
      "relation_name": "con_moorland",
      "pip": {
            "company_name": "fiberpark gmbh", 
            "agg_id": 412,
            "phone": "+43-1-987654321", 
            "email_to": "support@my-own-domain.at", 
            "pip_code": "fiber.pip"
      },
      "ano": {
            "company_name": "fiberpark gmbh",
            "agg_id": 413,
            "phone": "+43-1-987654321",
            "email_to": "support@my-own-domain.at",
            "ano_code": "fiber.ano"
      },
      "center": "48.208547,16.372959",
      "customer_reference": "string",
      "distance": "12.3",
      "reference_url": "http://example.com"
    }
]