carriercheck()

The Broadband API

The carriercheck() function provides ISRA/FTU information at a location.

For a carrier type (either Copper or Fiber) and a given address it provides you with a list of all connections available at that address. Telephone numbers associated with a connection and an indication whether the connection is used for broadband traffic or not.

Production URL

https://api.nextpertise.nl/broadband/v1

Testing URL

https://api.nextpertise.nl/test/broadband/v1 See Testing for more information.

Method

carriercheck

Input

Carriercheck request v1

https://api.nextpertise.nl/schemas/broadband/carriercheck_request_v1.json

Requests an overview of the ISRA/FTU access points available on a specific location.

allOf

Location

type

object

properties

  • carrier

Select the kind of carrier ‘Copper’ or ‘Fiber’ to query.

type

string

enum

Copper, Fiber

Output

Carriercheck reply v1

https://api.nextpertise.nl/schemas/broadband/carriercheck_reply_v1.json

Describes the data returned from a carriercheck request.

type

object

properties

  • line

Carrierinfo

additionalProperties

False

Example

Copper Example

Request

curl -s -u <credential> https://api.nextpertise.nl/broadband/v1 -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "carriercheck",
    "params":{
        "carrier":"Copper",
        "zipcode":"2408ZE",
        "housenr":2
    }
}' | jq .

Reply

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": {
        "line": {
            "status": null,
            "kind": "Copper",
            "vendor": "MDF",
            "number": null,
            "type": null,
            "connectionpoint": [
                {
                    "name": "Al-C",
                    "isra": "001/B/TR/TECHNISCHE RUI",
                    "nl1lines": 150,
                    "nl2lines": 50,
                    "connection": [
                        {
                            "type": 0,
                            "futuretype": 0,
                            "number": null,
                            "futurenumber": null
                        },
                        {
                            "type": 2,
                            "futuretype": 9,
                            "number": "172xxxxxx",
                            "futurenumber": null
                        },
                        {
                            "type": 0,
                            "futuretype": 0,
                            "number": null,
                            "futurenumber": null
                        }
                    ]
                }
            ]
        }
    }
}

Fiber Example

Request

curl -s -u <credential> https://api.nextpertise.nl/broadband/v1 -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "carriercheck",
    "params":{
        "carrier":"Fiber",
        "zipcode":"2408ZE",
        "housenr":2
    }
}' | jq .

Reply

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": {
        "line": {
            "kind": "Fiber",
            "areapop": "al-3c",
            "vendor": "REGG",
            "nlstype": 6,
            "connectionpoint": [
                {
                    "id": null,
                    "ftu-type": "FTU_GN02",
                    "connection": [
                        {
                            "type": 5,
                            "futuretype": 9
                        }
                    ]
                }
            ]
        }
    }
}