Usage

Swagger-UI: ac-v2 | OpenAPI file: ac-v2.yml

Before anything can be ordered for a specific address, the package availability must be checked.

Table of contents

Required information

For every check request, at least the zip code and the corresponding house number is required. If the requested location has a house number addition, that’ll need to be supplied as well.

Some connection providers have the notion of a room. A room is actually a separate location on an address, which is not registered in the BAG (Dutch registry for addresses and buildings. Contains information about the actual address of a building, as well as other information.) information.

Example request:

{
    "requestLocation": {
        "postcode": "1234AB",
        "houseNum": 56,
        "houseNumAdd": "BIS",
        "room": "B"
    }
}

When the house number addition and/or room are not required, they either be left empty, or they can be left out completely.

Check reply

When a proper address has been entered, the availability checker will return the following information:

  • The street and city of the requested location.
  • All available carrier types (Copper/Fiber).
  • Provider information specific to the carrier type. For example, for a KPN copper location, the available IS/RA points as well as telephone numbers and service IDs on the address will be returned.
  • Information about the available packages.

See the examples for an overview of example responses.

Package information

As mentioned, an availability check result will also return the orderable packages. The package information contains the following information:

  • The package code (required for placing orders).
  • The product codes (also required for placing orders).
  • The technology (Fiber or Copper).
  • Product information (billing information).
  • Parameters available for ordering.

Ordering

The information from the availability result can be used to place orders. Depending on the package parameters, this needs to be done using either the Line order or the Line quotation API. More information about placing order can be found in there.

Version 2 of this API introduced the parameter lineQuotationRequired to indicate packages that require a custom quotation.