Field types

The schemas defining legal input and output are constructed out of lower level schemas. Together these form a type hierarchy. This page defines those construction elements.

Nullable values

These are regular values which are allowed to have a “null” value.

Optional date

Optional date in international format YYYY-MM-DD
oneOf
Date
type null

Optional integer

An integer or no value at all.
type integer / null

Optional string

A string or no value at all.
type string / null

Address types

Address types define addresses in several forms and formats.

Address

A complete address.
allOf
Location
Extended location

Location

Defines a location through zipcode/housenr combination.
type object
properties
  • zipcode
Zipcode
  • housenr
The house number that with the zipcode identifies an address.
type integer
  • housenrext
House number suffix.
type string / null
maxLength 6

Extended location

Extends a location with street and city references.
type object
properties
  • street
The street name.
Optional string
  • city
The city name.
Optional string

Extended address

A complete address with province, municipality, latitude and longitude.
allOf
Location
Extended location
type object
properties
  • province
type string / null
  • municipality
type string / null
  • latitude
type string / null
  • longitude
type string / null

Zipcode

The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be ‘0’ unless when testing.
type string
pattern ^[0-9]{4}[A-Z]{2}$

Date and time

Date

Date in international format YYYY-MM-DD
type string
pattern ^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$

Datetime

Datetime in international format YYYY-MM-DD HH:MM:SS
type string
pattern ^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-5][0-9]$

Unsorted

Carrier Product

Define a carrier by its product definition and provide a specification.
allOf
Product
type object
properties
  • distance
Optional indication of the non-recurring costs (supplier specific).
Optional string
  • area
Optional indication of the recurring costs (supplier specific).
Optional string
  • carrier_type
Carrier type
  • circuits
type array
items
type integer
minItems 0
  • download
type integer
  • upload
type integer
  • terminate_voice
If this field is true, you terminate the voice connection when ordering this carrier.
type boolean
  • cpe
type array
items
type integer
  • sla
type array
items
type integer

Nls Type

For the KPN WBA service the distance field contains something called NLS. This is an integer indicating the availability of a connection point. Numbers 1 through 3 refer to copper connections, the others refer to fiber connections.

value meaning
1 Fully connected copper pair
2 Maximum of three connections in copper cable needed
3 All other situations (i.e. cable planning, engineering, etc.)
6 Customer location connected, including FTU
7 Customer location not connected, fiber cable available on customer premises.
8 Customer location not connected, fiber cable available near customer premises.
9 Customer location not connected on fiber.
21 FTTO Area: Customer location connected, including FTU with free fiber.
23 FTTO Area: Customer location not connected or no free fiber available. Free fiber available near customer premises.
24 FTTO Area: Customer location not connected. No fiber available yet, but availability is planned in this area.

Carrier status

Service is possible or not.
type string / null
enum 0, O, C, P, None

Carrier type

Defines the physical medium for internet access and whether the medium is shared with other (voice) services.

FttH and FttO are both Fiber connections with other parameters.

type string
enum Copper, Copper_shared, Copper_only, BCopper_only, Fiber, FttH, FttO

Circuit Product

Define a circuit by its product definition and provide a specification.
allOf
Product
type object
properties
  • max_upload
Highest possible upload speed in kb/s
type integer
  • max_download
Highest possible download speed in kb/s
type integer
  • min_upload
Lowest upload speed in kb/s
type integer
  • min_download
Lowest upload speed in kb/s
type integer
  • overbooking
type integer
  • quality
type string
enum regular, premium

Customer Code

Identifies a customer by this key
type string
pattern ^DB[0-9]{3,}$

Line

type object
properties
  • max_download
The maximum available download speed in kb/s.
type integer
  • max_upload
The maximum available upload speed in kb/s.
type integer
  • area
A (possibly empty) string indicating recurring costs.
type string
  • distance
A (possible empty) string indicating setup costs.
type string
  • carrier
Carrier type
additionalProperties False

Lines

type object
patternProperties
  • ADSL | VDSL | BVDSL | SDSL | SDSL.bis | Fiber | VPLUS | BVPLUS
Line
additionalProperties False

Period

Period formatted as YYYY-MM
type string
pattern ^[1-9][0-9]{3}-[01][0-9]$

Product

type object
properties
  • product_id
Product ID
  • name
The product name.
type string
  • description
Describes the product.
type null / string
  • extrainfo
Additional information about the product
type null / string

Product ID

Identifies an individual product by numeric id.
type integer
minimum 0

Product state

State the product is in. One of

PROCESSING
Product is being ordered.
ACTIVE
Product is operational.
TERMINATED
Product is terminated.
type string
enum PROCESSING, ACTIVE, TERMINATED

Service ID

Service label, matches the carrier’s nid when the service is provided by Nextpertise.
type null / string

Services list

Possibly empty list of services and phonenumbers
type array
items
type object
properties
  • service
Service ID
  • phonenumber
Telephone number

Telephone number

Dutch national telephone number: 0-prefix followed by 9 digits.
type string / null
pattern ^(?=^.{10}$)0[0-9]*$

Carrierinfo

Describes the Copper or Fiber connections available at a location.
oneOf
Copper endpoint
Fiber endpoint

Copper connector

Describes how a single connector is being used.
type object
properties
  • type
type integer
  • serviceid
Service ID
  • number
Telephone number
  • phonetype
Optional string
  • futuretype
Optional integer
  • futureserviceid
Service ID
  • futurenumber
Telephone number
  • futurephonetype
Optional string
additionalProperties False

The type and futuretype fields (when present) contain a number in the range 0 to 11 indicating the type of a connection:

key value meaning
type or futuretype 0 Not in use
1 Fixed Line service
2 Telephony service
3 MDF Broadband service
4 SDF Broadband service
5 ODF Broadband service
6 ODF Broadband service
7 ODF Broadband service
8 Unknown service
9 No change
10 MDF Bundle
11 MDF Bundle

Copper connectionpoint

Describes a set of copper connectors.
type object
properties
  • name
Connection point name
type string
  • isra
ISRA point identification
type string
  • nl1lines
Number of lines present at the location
type integer
  • nl1lines_available
Number of unassigned lines at the location. Unassigned means that neither telephone nor broadband services are using these lines.
type integer
  • nl2lines
type null / integer
  • connection
type array
items
Copper connector
  • bonding_allowed
Optional integer
  • plan_date
Optional string
  • cable_length
Optional integer
  • san_only
Optional string
additionalProperties False

Fiber connector

Describes how a single connector is being used.
type object
properties
  • type
type integer
  • odfid
Service ID
  • futuretype
Optional integer
  • futureodfid
Service ID
additionalProperties False

The type and futuretype fields (when present) contain a number in the range 0 to 11 indicating the type of a connection:

key value meaning
type or futuretype 0 Not in use
1 Fixed Line service
2 Telephony service
3 MDF Broadband service
4 SDF Broadband service
5 ODF Broadband service
6 ODF Broadband service
7 ODF Broadband service
8 Unknown service
9 No change
10 MDF Bundle
11 MDF Bundle

Fiber connectionpoint

Describes the layout and contents of an fiber endpoint.
type object
properties
  • id
Optional string
  • ftu_type
Optional string
  • connection
type array
items
Fiber connector
  • carrier-status
Optional string
  • nlstype
Optional integer
  • plan_date
Optional string
  • has_date
Optional string
additionalProperties False

Copper endpoint

Describes the layout and contents of an copper endpoint.
type object
properties
  • kind
Declares this object to describe a Copper endpoint
type string
enum Copper
  • status
Carrier status
  • number
Telephone number
  • vendor
type string
  • type
Optional string
  • serviceid
type string / null
  • additionalserviceid
type string / null
  • connectionpoint
type array
items
Copper connectionpoint
  • plan_date
Optional string
  • isra_pin
Optional integer

Fiber endpoint

Describes the layout and contents of a fiber endpoint.
type object
properties
  • kind
type string
enum Fiber
  • areapop
type string / null
  • vendor
type string
  • nlstype
type integer
  • connectionpoint
type array
items
Fiber connectionpoint
additionalProperties False

Broadband NID

Carrier or circuit identification. To harmonize the way ordered broadband products are identified.
type string / null
pattern ^[1-9][0-9]{3}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$

Carrier product

Describe the carrier component of the connection.
type object
properties
  • nid
Broadband NID
  • tags
type array
items
type string
  • product
Product
  • ftu_type
Define the Fiber Termination Unit.
type string / null
  • base_technology
Base technology for connection (POTS, SDSL, FIBER).
type string
  • carrier_type
Carrier type
  • plan_date
Optional date
  • data_technology
Data transfer technology (ADSL, VDSL, etc).
type string
  • state
Product state
  • phonenumber
Telephone number
  • order_date
Optional date
  • israspecs
Label of the ISRA location.
type string / null
  • israpin
Pin in isra on which the wire terminates.
type integer / null
  • additional_israpin
Pin in isra on which the second wire of a bonded connection terminates.
type integer / null
additionalProperties False

Circuit product

Describes a circuit component of the connection.
type object
properties
  • nid
Broadband NID
  • tags
type array
items
type string
  • product
Product
  • bandwidth_up
Maximum upload capacity in kb/s.
type integer
  • premium
Indicates if the circuit is a regular or premium product.
type boolean
  • bandwidth_down
Maximum download capacity in kb/s.
type integer
  • plan_date
Optional date
  • vlan
VLAN ID when applicable
type string / null
  • vci
VCI value when applicable
type integer / null
  • state
Product state
  • ipv4
The IPv4 address assigned to this circuit.
type string / null
  • online
Indicator if the connection is active or not.
type string
enum online, offline, unknown
  • order_date
Optional date
  • auth_user
The username used to login on RADIUS with this circuit.
type string / null
  • vpi
VPI value when applicable
type integer / null
additionalProperties False

Port status diagnostics

DSLAM port status as reported by KPN
type object
properties
  • kind
Only valid for the port_status.
type string
enum port_status
  • status
type array
items
type object
properties
  • operation
type object
properties
  • stability
type string
  • linesync
type boolean
  • laststatus
type string
additionalProperties False
  • configuration
type object
properties
  • cpetype
type string
  • dsltype
type string
additionalProperties False
  • parameter
type object
patternProperties
  • ^lqd.parameter..+$
type object
properties
  • downstream
type string
  • unit
type string
  • upstream
type string
additionalProperties False
additionalProperties False
  • diagnostics
type array
items
type object
properties
  • explanation
type string
  • probablecause
type string
additionalProperties False
minItems 0
additionalProperties False
maxItems 2
minItems 1
additionalProperties False

Line analyse diagnostics

SELT line status as reported by KPN
type object
properties
  • kind
Only valid for the line_analysis.
type string
enum line_analysis
  • status
type object
properties
  • ScanDetails
type object
properties
  • ScanName
type string
  • ProgressId
type string
additionalProperties False
  • ScanResponses
type array
items
type object
properties
  • ExitValue
type string
  • Answer
type string
  • Detail
type string
additionalProperties False
minItems 0
  • TransactionDetails
type string
  • ErrorDetails
type object
properties
  • ErrorCode
type string
  • ErrorDescription
type string
additionalProperties False
additionalProperties False
additionalProperties False