Reading the Register

Specific OAID

Authorized users can make requests to the API to validate and check the existence of an OAID. To do this, directly specify the respective OAID in the path.

The API response provides information about the existence and validity of the OAID.

Tip

Always use a trailing slash ("/").
Example: https://api.oaid.at/v1/isp/codes/ABCD1234/

The OAID Register allows (for the role of OAID owner) the creation and updates of OAIDs. To ensure that the OAID has been received during the creation process, its receipt must be confirmed. Details can be found in the Request-Confirm workflow. For the requesting of OAIDs, it is relevant that the OAID owner has both confirmed their general consent for publication and also each individual OAID. Only these OAIDs can be read out via the API.

Understanding Status Codes

The feedback responses use HTTP Status Codes. The distinction of these codes is important for interpretation.

200 OK - OAID exists

The OAID exists and has been confirmed. The response also includes a label indicating the OAID owner.

Note

The OAID owner may represent multiple infrastructure providers. It is currently not possible to split the OAID among these infrastructure providers.

422 UNPROCESSIBLE ENTITY - Invalid Format

The OAID is not a valid character combination (e.g., is 7 digits long, …). Such an OAID cannot exist.

404 NOT FOUND - OAID Does Not Exist

Although the OAID adheres to the valid nomenclature, the OAID itself does not exist yet. This response also results for OAIDs that have been pulled, but not confirmed yet.

403 FORBIDDEN - Details Not Allowed

This response confirms the existence of the OAID, but the owner has not granted or has withdrawn general permission to read OAIDs.

429 TOO MANY REQUESTS - Request Limit Reached

This message appears when the allowed limit (number of requests per time unit) is reached. Currently, 10 queries are allowed within 10 minutes. This mechanism aims to prevent the register from being read through trial and error.

No Statement Regarding the OAID

This response does not provide any information regarding the requested OAID.

It is best to pause the requests and start again after a few minutes.

Example

$ curl --request GET --location "https://api.oaid.at/v1/isp/codes/ABCD1234/" \
$  --header "Authorization: Bearer <access_token>" \
$  --header "Accept: application/json"
---> 100%
{
    "tenant": "fiberpark",
    "code": "ABCD1234",
    "version": "v8",
    "created_at": "2022-03-01T10:35:03.392+01:00",
    "modified_at": "2022-03-01T10:37:01.012+01:00",
}