Getting Started
https://api.nextpertise.nl
Nextpertise's API aims to expose the entire Nextpertise infrastructure via a standardized programmatic interface. Using
Nextpertise's API, you can do EVERYTHING you can do on incontrol.nextpertise.nl webportal.
The Nextpertise API is a JSON-RPC API based on HTTPS requests. If you are a Nextpertise partner, you can obtain your InControl user credential which is also valid as API credential.
The Nextpertise API is a JSON-RPC API based on HTTPS requests. If you are a Nextpertise partner, you can obtain your InControl user credential which is also valid as API credential.
Who is Nextpertise?
Nextpertise is a Dutch Internet Service Provider (ISP) which focused on Broadband connections and Managed
Infrastructure. Nextpertise is known for Wholesale Broadband Access (WBA) and Managed Infrastructure services as Private
Cloud, Kubernetes Hosting, DNS and Radius services.
Nextpertise offers public APIs with three audiences in mind.
Nextpertise offers public APIs with three audiences in mind.
- Nextpertise partners
- Nextpertise customers
- Developers
Endpoints
The API is accessed by making HTTPS requests to a specific version endpoint URL. All request are HTTP POST methods with
a JSON-RPC payload. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol. The last parameter in
the endpoint is the version number. Currently we are on Version 1 for all endpoints.
The stable prefix URL for all endpoints is:
The stable prefix URL for all endpoints is:
https://api.nextpertise.com/<product_class>/v1
Requests
Requests must be sent over HTTPS with any payload formatted in JSON-RPC. Request must contain a
Authenticationheader.
Using JSON
The API uses JSON-RPC 2.0 over HTTP for all interaction. To access the API you need to POST a JSON document to the
product class URL.
There are many implementations of JSON-RPC clients in several popular languages available. In this document we will use the Linux command line tool curl in all examples. This is done because it illustrates 'what goes over the line' and to remain independent of a particular implementation language.
A JSON-RPC request is a JSON document containing 4 fields:
There are many implementations of JSON-RPC clients in several popular languages available. In this document we will use the Linux command line tool curl in all examples. This is done because it illustrates 'what goes over the line' and to remain independent of a particular implementation language.
A JSON-RPC request is a JSON document containing 4 fields:
The method parameters (actually the entire contents of the params field) are structurally validated using JSON Schema.{ "jsonrpc": "2.0", "id": <correlation id>, "method": "<name of method to call>", "params": { "method_parameter_1": ..., "method_parameter_N": ... } }
Using JSON Schema
The JSON Schema files are accessible under http://api.nextpertise.nl/schemas.
There is a direct correspondance between the API endpoint URL https://api.nextpertise.nl/broadband/basic/v1 for the zipcode method and the URL for the accompanying schemas
https://api.nextpertise.nl/schemas/broadband/basic/zipcode_request_v1.json and https://api.nextpertise.nl/schemas/broadband/basic/zipcode_reply_v1.json.
There is a direct correspondance between the API endpoint URL https://api.nextpertise.nl/broadband/basic/v1 for the zipcode method and the URL for the accompanying schemas
https://api.nextpertise.nl/schemas/broadband/basic/zipcode_request_v1.json and https://api.nextpertise.nl/schemas/broadband/basic/zipcode_reply_v1.json.
Authenticate
In order to use the API one needs to authenticate first.
API endpoints are accessible via the same credentials as the InControl webportal. All user accounts are available on both Basic Auth authentication (rfc7617) as on JWT authentication (rfc6749/rfc7519). All accounts are protected by either IP whitelisting or a TOTP Token (rfc6238) as second factor (or both). Both IP whitelisting as 2FA TOTP are managed from the Profile page in InControl or the User API methods
API endpoints are accessible via the same credentials as the InControl webportal. All user accounts are available on both Basic Auth authentication (rfc7617) as on JWT authentication (rfc6749/rfc7519). All accounts are protected by either IP whitelisting or a TOTP Token (rfc6238) as second factor (or both). Both IP whitelisting as 2FA TOTP are managed from the Profile page in InControl or the User API methods
get_profile()and
set_profile().
Basic Authentication Example
With curl you would use it as:
curl -u '<username>:<password>' https://api.nextpertise.nl/user/v1 -d '{}'
JWT Authentication Example
The token is used to request access to the API services:
A JWT token is obtained by logging in:
When applying for additional API access accounts you will receive a username password combination that can be used for JWT Authentication.curl -s -H 'Authorization: Bearer <your token>' https://api.nextpertise.nl/user/v1 ...
A JWT token is obtained by logging in:
curl -u username:password https://api.nextpertise.nl/jwt/log-in {"token_type":"Bearer","expires_in":86400,"access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..78"} This will produce a token which is valid for 24 hours.
A JWT token is stateless and therefore it cannot be invalidated within the expiration time of the token itself.
Errors
https://api.nextpertise.nl
Errors are per JSON-RPC 2.0 specification returned through the error object.
There is an exception though. The basic zipcode() and extended zipcode() functions return the combined results of multiple backend calls. A single backend error would therefore suppress the valid results from the other providers. To alleviate this these two functions may return errors inline with the other results in their error keys.
There is an exception though. The basic zipcode() and extended zipcode() functions return the combined results of multiple backend calls. A single backend error would therefore suppress the valid results from the other providers. To alleviate this these two functions may return errors inline with the other results in their error keys.
List of errors
| Code | Description |
|---|---|
| 001 | Undocumented Error, please report to Nextpertise and refer to cid: %s. This error message indicates that something happened that we didn't anticipate. By reporting this incident to Nextpertise, mentioning the cid (correlation id) we may be able to resolve this and provide a better error message in the future. |
| 002 | Invalid zipcode/housenr combination: (%s,%d,%s). The given zipocde, house number, house number extension is not recognized as a valid combination. Use the The Postcodes API functions to select a valid combination. |
| 003 | The given address is valid but the provider does not service this address. This is most likely due to infrastructural constraints that will not change in the foreseeable future. |
| 004 | Service temporarily not available at this address (%s,%d,%s). The given address is valid but the provider cannot service this address or offer any information about it. This is must likely due to a temporary disruption in the backoffice system of the provider. |
| 005 | User is not authorised to order (%s). The user is not authorised to order product %s. By contacting Nextpertise we can discuss your options for future orders. |
| 006 | Failed to create requested (%s).
Something went wrong during the creation of %s. This error can occur due to multiple reasons, for instance:
|
| 007 | Failed to delete requested (%s).
Something went wrong during the deletion of (%s). As of now, there is one main reason why this error occurs, i.e.:
|
| 008 | Failed to update requested (%s).
Something went wrong while updating (%s). As of now, there is one main reason why this error occurs, i.e.:
|
| 010 | Connection too complex for this version of the software. Please contact Nextpertise. This error may occur when requesting a zipcode check on KPN WBA on an address that KPN has labeled a 'Complex Address'. Eventually we expect to be able to handle this situation in the API but for now the only recourse is to contact Nextpertise. |
| 011 | JSON-RPC request or reply does not comply with its schema. This error may occur when posting an invalid request to the API, but also when the API returns an invalid response. Nextpertise's internal APIs are also validated against schemas so the error may have been generated in an internal API call trying to satisfy the initial request. You can verify that the request you issue validates against the published schema for the API call. If you are certain your request is valid please contact Nextpertise so that we can resolve the problem. |
| 012 | Config Prohibited Error. This error occurs when a user tries to perform an action it is not authorized to. Contact your employer if you feel this is not right.. |
HTTP Error codes
| Code | Description |
|---|---|
| 401 | Unauthorized. |
| 404 | Not Found. |
Details
401
You tried to access a resource for which you are not authorized:
You tried to access a resource for which you are not authorized:
curl -v -u 'user:pass' https://api.nextpertise.nl/postcodes/v1 -d '{}'| jq .
produces:
> POST /postcodes/v1 HTTP/1.1 > Host: api.nextpertise.nl > Authorization: Basic dXNlcjpwYXNz > Content-Length: 2 > Content-Type: application/json > < HTTP/1.1 401 Forbidden < Date: Mon, 13 Apr 2020 07:33:47 GMT < Content-Type: application/json; charset=utf-8 < Content-Length: 45 < Access-Control-Allow-Origin: * < { "message" : "You cannot consume this service" }
404
You tried to access a resource that doesn't exist:
You tried to access a resource that doesn't exist:
curl -v -u 'user:pass' https://api.nextpertise.nl/doesnotexist
produces:
> GET /doesnotexist HTTP/1.1 > Host: api.nextpertise.nl > Authorization: Basic dXNlcjpwYXNz > User-Agent: curl/7.64.1 > Accept: */* > < HTTP/1.1 404 Not Found < Date: Mon, 13 Apr 2020 07:51:05 GMT < Content-Type: text/html; charset=iso-8859-1 < Content-Length: 196 < Access-Control-Allow-Origin: * < < !DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> <html><head> <title>404 Not Found</title> </head><body> <h1>Not Found</h1> <p>The requested URL was not found on this server. </body></html>
Broadband
https://api.nextpertise.nl/broadband/v1
JSON-RPC
cancel_transaction()
Since v1.24.0
Cancel transaction
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null, one of | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| uuid | string, one of |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| uuid | string | |
| customer_account_id | integer, null | |
| action | enum | Enum options:offer|new|migrate|change|terminate|migrate_out. undefined |
| open | boolean | |
| state | enum | Enum options:new|processing|finished|cancelled. undefined |
| last_updated | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| closed_at | string, null | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| closed_at | null, one of | |
| update_contacts | null, boolean | |
| sitesurvey_plan_date | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_plan_date | null, one of | |
| sitesurvey_date_replan | boolean, null | |
| sitesurvey_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_executed_date | null, one of | |
| sitesurvey_document | string, null | |
| internalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_plan_date | null, one of | |
| internalworks_date_replan | boolean, null | |
| internalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_executed_date | null, one of | |
| externalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_plan_date | null, one of | |
| externalworks_date_replan | boolean, null | |
| externalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_executed_date | null, one of | |
| permit | string, null | |
| expected_completion_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date | null, one of | |
| expected_completion_date_delayed | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date_delayed | null, one of | |
| expected_completion_date_is_forecast | boolean, null | |
| expected_completion_date_replan | boolean, null | |
| customer_wish_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| customer_wish_date | null, one of | |
| customer_wish_date_replan | boolean, null | |
| cleanorder_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cleanorder_executed_date | null, one of | |
| created_at | string, null | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| cancelled_by | string, null | |
| cancel_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cancel_date | null, one of | |
| cancel_reason | string, null | |
| cancel_requested | boolean, null | |
| cancel_possible | boolean | |
| purchase_price | number, null | |
| sales_price | number, null | |
| purchase_teardown_price | number, null | |
| sales_teardown_price | number, null | |
| purchase_setup_price | number, null | |
| sales_setup_price | number, null | |
| change_proposal | object | |
| document_before_transaction | object, null | |
| document_after_transaction | object, null | |
| ftu_count | integer, null | |
| appointment_url | string, null | |
| is_complex | boolean, null | |
| is_realtime | boolean, null | |
| replan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| replan_date | null, one of | |
| replan_requested | boolean, null | |
| replan_possible | boolean |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "cancel_transaction",
"params": {
"nid": "2408ZE000100300"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"uuid": "291cfee4-e413-4350-91f8-2392032b1a31",
"customer_account_id": null,
"nid": "2408ZE000100300",
"action": "new",
"state": "new",
"open": true,
"created_at": "2020-10-22T16:41:04Z",
"last_updated": "2020-10-23T07:45:52Z",
"update_contacts": null,
"sitesurvey_plan_date": null,
"sitesurvey_date_replan": null,
"sitesurvey_executed_date": null,
"sitesurvey_document": null,
"internalworks_plan_date": null,
"internalworks_date_replan": null,
"internalworks_executed_date": null,
"externalworks_plan_date": null,
"externalworks_date_replan": null,
"externalworks_executed_date": null,
"permit": null,
"expected_completion_date": null,
"expected_completion_date_delayed": null,
"expected_completion_date_is_forecast": null,
"expected_completion_date_replan": null,
"customer_wish_date": null,
"customer_wish_date_replan": null,
"replan_date": null,
"replan_requested": false,
"cleanorder_executed_date": "2020-09-10",
"purchase_price": null,
"sales_price": null,
"purchase_teardown_price": null,
"sales_teardown_price": null,
"purchase_setup_price": null,
"sales_setup_price": null,
"cancelled_by": "customer",
"cancel_date": "2020-10-23",
"cancel_reason": "Customer cancel",
"cancel_requested": true,
"ftu_count": null,
"appointment_url": null,
"document_before_transaction": null,
"document_after_transaction": {
"sla": {
"product": {
"name": "Silver SLA",
"supplier": "TELE2",
"product_id": 751,
"description": "TELE2 Silver"
},
"order_date": "2020-10-23"
},
"active": false,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 10,
"zipcode": "2408ZE",
"latitude": "52.1266051",
"province": "Zuid-Holland",
"longitude": "4.6533684",
"housenrext": "",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000100300",
"tags": [],
"product": {
"area": null,
"name": "SDSL.bis 2-20Mb",
"active": true,
"upload": null,
"nlstype": null,
"distance": "Onnet",
"download": null,
"supplier": "TELE2",
"product_id": 665,
"test_label": null,
"carriertype": "Copper_only",
"copper_pairs": 1,
"base_technology": "POTS",
"data_technology": "SDSL.bis",
"estimated_delivery_duration": null
}
},
"enduser": {
"uuid": "17a0ac8b-c6ae-4a2d-aa97-2554244ae6ac"
},
"circuits": [
{
"nid": "2408ZE000100301",
"port": 12,
"tags": [],
"vlan": 2,
"product": {
"qos": null,
"area": "METRO",
"name": "Regular circuit 1Mb (Metro)",
"active": true,
"is_pvc": true,
"upload": 1024,
"quality": "REGULAR",
"download": 1024,
"supplier": "TELE2",
"product_id": 679,
"overbooking": null,
"service_type": null,
"transport_instance": null
},
"provisioning_type": "ppp"
}
],
"supplier": "TELE2",
"transaction": {
"uuid": "291cfee4-e413-4350-91f8-2392032b1a31",
"action": "new",
"state": "new"
},
"contract_period": {
"to": null,
"from": null,
"last_change": null
},
"contract_duration": 12,
"location_contacts": [
{
"name": "Roman",
"uuid": "e0a31814-1974-4bd7-8cfd-c4ff0c4c5e74",
"email": null,
"primary": true,
"phonenumber": "0636363633"
}
]
},
"change_proposal": {}
}
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "cancel_transaction",
"params": {
"uuid": "291cfee4-e413-4350-91f8-2392032b1a31"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"uuid": "291cfee4-e413-4350-91f8-2392032b1a31",
"customer_account_id": null,
"nid": "2408ZE000100300",
"action": "new",
"state": "new",
"open": true,
"created_at": "2020-10-22T16:41:04Z",
"last_updated": "2020-10-23T07:45:52Z",
"update_contacts": null,
"sitesurvey_plan_date": null,
"sitesurvey_date_replan": null,
"sitesurvey_executed_date": null,
"sitesurvey_document": null,
"internalworks_plan_date": null,
"internalworks_date_replan": null,
"internalworks_executed_date": null,
"externalworks_plan_date": null,
"externalworks_date_replan": null,
"externalworks_executed_date": null,
"permit": null,
"expected_completion_date": null,
"expected_completion_date_is_forecast": null,
"expected_completion_date_replan": null,
"customer_wish_date": null,
"customer_wish_date_replan": null,
"cleanorder_executed_date": "2020-09-10",
"purchase_price": null,
"sales_price": null,
"purchase_teardown_price": null,
"sales_teardown_price": null,
"purchase_setup_price": null,
"sales_setup_price": null,
"cancelled_by": "customer",
"cancel_date": "2020-10-23",
"cancel_reason": "Customer cancel",
"cancel_requested": true,
"document_before_transaction": null,
"document_after_transaction": {
"sla": {
"product": {
"name": "Silver SLA",
"supplier": "TELE2",
"product_id": 751,
"description": "TELE2 Silver"
},
"order_date": "2020-10-23"
},
"active": false,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 10,
"zipcode": "2408ZE",
"latitude": "52.1266051",
"province": "Zuid-Holland",
"longitude": "4.6533684",
"housenrext": "",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000100300",
"tags": [],
"product": {
"area": null,
"name": "SDSL.bis 2-20Mb",
"active": true,
"upload": null,
"nlstype": null,
"distance": "Onnet",
"download": null,
"supplier": "TELE2",
"product_id": 665,
"test_label": null,
"carriertype": "Copper_only",
"copper_pairs": 1,
"base_technology": "POTS",
"data_technology": "SDSL.bis",
"estimated_delivery_duration": null
}
},
"enduser": {
"uuid": "17a0ac8b-c6ae-4a2d-aa97-2554244ae6ac"
},
"circuits": [
{
"nid": "2408ZE000100301",
"port": 12,
"tags": [],
"vlan": 2,
"product": {
"qos": null,
"area": "METRO",
"name": "Regular circuit 1Mb (Metro)",
"active": true,
"is_pvc": true,
"upload": 1024,
"quality": "REGULAR",
"download": 1024,
"supplier": "TELE2",
"product_id": 679,
"overbooking": null,
"service_type": null,
"transport_instance": null
},
"provisioning_type": "ppp"
}
],
"supplier": "TELE2",
"transaction": {
"uuid": "291cfee4-e413-4350-91f8-2392032b1a31",
"action": "new",
"state": "new"
},
"contract_period": {
"to": null,
"from": null,
"last_change": null
},
"contract_duration": 12,
"location_contacts": [
{
"name": "Roman",
"uuid": "e0a31814-1974-4bd7-8cfd-c4ff0c4c5e74",
"email": null,
"primary": true,
"phonenumber": "0636363633"
}
]
},
"change_proposal": {}
}
}
JSON-RPC
carriercheck()
Since v1.10.0
Requests an overview of the ISRA/FTU access points available on a specific location.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| carrier | enum | Enum options:Copper|Fiber. Select the kind of carrier 'Copper' or 'Fiber' to query. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| line | object, one of | Describes the layout and contents of an copper endpoint. |
| kind | enum | Enum options:Copper. Declares this object to describe a Copper endpoint |
| status | string, null | Service is possible or not. |
| number | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| vendor | string | |
| type | string, null | A string or no value at all. |
| serviceid | string, null | |
| additionalserviceid | string, null | |
| connectionpoint | array | |
| connectionpoint[#] | object | Describes a set of copper connectors. |
| name | string | Connection point name |
| isra | string | ISRA point identification |
| nl1lines | integer | Number of lines present at the location |
| nl1lines_available | integer | Number of unassigned lines at the location. Unassigned means that neither telephone nor broadband services are using these lines. |
| nl2lines | null, integer | |
| connection | array | |
| connection[#] | object | Describes how a single connector is being used. |
| type | integer, null | An integer or no value at all. |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| serviceid | null, string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| number | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| phonetype | string, null | A string or no value at all. |
| futuretype | integer, null | An integer or no value at all. |
| futurenid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| futureserviceid | null, string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| futurenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| futurephonetype | string, null | A string or no value at all. |
| bonding_allowed | integer, null | An integer or no value at all. |
| plan_date | string, null | A string or no value at all. |
| cable_length | integer, null | An integer or no value at all. |
| san_only | string, null | A string or no value at all. |
| plan_date | string, null | A string or no value at all. |
| isra_pin | integer, null | An integer or no value at all. |
| line | object, one of | Describes the layout and contents of a fiber endpoint. |
| kind | enum | Enum options:Fiber. undefined |
| areapop | string, null | |
| vendor | string | |
| connectionpoint | array | |
| connectionpoint[#] | object | Describes the layout and contents of an fiber endpoint. |
| id | string, null | A string or no value at all. |
| ftu_type | string, null | A string or no value at all. |
| connection | array | |
| connection[#] | object | Describes how a single connector is being used. |
| type | integer | |
| odfid | null, string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| futuretype | integer, null | An integer or no value at all. |
| futureodfid | null, string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| futurenid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| carrier_status | string, null | A string or no value at all. |
| nlstype | null, string, integer | |
| plan_date | string, null | A string or no value at all. |
| has_date | string, null | A string or no value at all. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "carriercheck",
"params": {
"carrier": "Copper",
"zipcode": "2408ZE",
"housenr": 2,
"housenrext": null
}
}
Reply example
{
"result": {
"line": {
"isra_pin": null,
"type": null,
"kind": "Copper",
"number": null,
"status": null,
"connectionpoint": [
{
"isra": "001/B/MTK/METERKAST",
"san_only": "False",
"nl1lines_available": 0,
"name": "Berh",
"nl2lines": 0,
"connection": [
{
"futurephonetype": null,
"type": 10,
"nid": null,
"number": null,
"futureserviceid": null,
"serviceid": "ABC12345",
"phonetype": null,
"futurenid": null,
"futurenumber": null,
"futuretype": 9
}
],
"plan_date": null,
"nl1lines": 1,
"cable_length": 13,
"bonding_allowed": 2
}
],
"vendor": "MDF",
"plan_date": null
}
},
"jsonrpc": "2.0",
"id": 1
}
JSON-RPC
change_connection()
Upgrades or downgrades connection
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| carrier | integer | Identifies an individual product by numeric id. |
| circuit | array | |
| circuit[#] | object | |
| circuit | integer | Identifies an individual product by numeric id. |
| tags | array | |
| tags[#] | string | Regex:[a-zA-Z0-9\/=:_-]+. |
| vlan | integer | |
| vci | integer | |
| vpi | integer | |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| tags | array | |
| tags[#] | string | Regex:[a-zA-Z0-9\/=:_-]+. |
| contact_name | string | |
| contact_phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| contract_duration | integer | |
| additional_contact_phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| custwishdate | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| custwishdate | null, one of | |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| planned | boolean | |
| updating | object | |
| ^[1-9][0-9]{3}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$ | object | |
| vlan | boolean | |
| circuit_product | boolean |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "change_connection",
"params": {
"nid": "2408ZE000100100",
"contract_duration": 12,
"contact_name": "test",
"enduser": {
"uuid": "abcde123-0123-4abc-9876-012345678912"
},
"contact_phonenumber": "0101234567",
"circuit": [
{
"circuit": 756,
"nid": "2408ZE000100101",
"vlan": 6
},
{
"circuit": 756,
"vlan": 7
}
]
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"planned": false,
"updating": {
"2408ZE000100101": {
"circuit_product": false,
"vlan": false
}
}
}
}
JSON-RPC
change_sla()
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| product_id | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| uuid | string | |
| action | enum | Enum options:offer|new|migrate|change|terminate|migrate_out. undefined |
| open | boolean | |
| state | enum | Enum options:new|processing|finished|cancelled. undefined |
| last_updated | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| sitesurvey_plan_date | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_plan_date | null, one of | |
| sitesurvey_date_replan | boolean, null | |
| sitesurvey_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_executed_date | null, one of | |
| sitesurvey_document | string, null | |
| internalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_plan_date | null, one of | |
| internalworks_date_replan | boolean, null | |
| internalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_executed_date | null, one of | |
| externalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_plan_date | null, one of | |
| externalworks_date_replan | boolean, null | |
| externalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_executed_date | null, one of | |
| expected_completion_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date | null, one of | |
| expected_completion_date_delayed | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date_delayed | null, one of | |
| expected_completion_date_is_forecast | boolean, null | |
| expected_completion_date_replan | boolean, null | |
| customer_wish_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| customer_wish_date | null, one of | |
| customer_wish_date_replan | boolean, null | |
| cancelled_by | string, null | |
| cancel_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cancel_date | null, one of | |
| cancel_reason | string, null | |
| cancel_possible | boolean | |
| replan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| replan_date | null, one of | |
| replan_requested | boolean | |
| cleanorder_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cleanorder_executed_date | null, one of | |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| cancel_requested | boolean, null | |
| document_before_transaction | null, object | |
| document_after_transaction | null, object | |
| document | null, object | |
| ftu_count | null, integer | |
| appointment_url | string, null | |
| replan_possible | boolean | |
| is_complex | boolean, null | |
| is_realtime | boolean, null | |
| closed_at | string, null | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| closed_at | null, one of |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "change_sla",
"params": {
"nid": "3901KV000070800",
"product_id": 759
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"uuid": "db320536-5484-4442-820f-1b125569820b",
"nid": "3901KV000070800",
"action": "change",
"state": "processing",
"open": true,
"created_at": "2021-08-02T09:55:31Z",
"last_updated": "2021-08-02T09:55:31Z",
"document_before_transaction": {
"sla": {
"product": {
"name": "Best Effort",
"supplier": "KPNWBA",
"product_id": 758,
"description": "KPNWBA Best Effort - Standard (FTT[H/O])"
},
"order_date": "2021-08-02"
},
"active": true,
"address": {
"city": "Veenendaal",
"street": "De Brinken",
"housenr": 7,
"zipcode": "3901KV",
"latitude": "52.0199694",
"province": "Utrecht",
"longitude": "5.5612248",
"housenrext": "",
"municipality": "Veenendaal"
},
"carrier": {
"nid": "3901KV000070800",
"tags": [],
"product": {
"area": null,
"name": "W-ADSL-WN/Fiber/GoF/MIGRATE_FTTH",
"active": true,
"maxnls": null,
"upload": null,
"nlstype": "FMIGRATE",
"distance": null,
"download": null,
"supplier": "KPNWBA",
"product_id": 636,
"test_label": false,
"carriertype": "Fiber",
"channel_type": "Ethernet",
"copper_pairs": 1,
"base_technology": "FttH",
"data_technology": "GoF",
"aggregated_carriertype": "Fiber",
"aggregated_data_technology": "Fiber",
"estimated_delivery_duration": "10d"
},
"ftu_type": "FTU_TK01",
"serviceid": "HQE73515",
"additional_serviceid": null
},
"enduser": {
"uuid": "17a0ac8b-c6ae-4a2d-aa97-2554244ae6ac"
},
"circuits": [
{
"nid": "3901KV000070801",
"vlan": 6,
"product": {
"qos": "Best Effort",
"area": null,
"name": null,
"active": true,
"is_pvc": true,
"upload": 100000,
"quality": "REGULAR",
"download": 100000,
"supplier": "KPNWBA",
"product_id": 279,
"overbooking": 0,
"service_type": 7396,
"transport_instance": "TI-NEXT/1"
},
"provisioning": {
"enabled": true,
"blocked": false,
"ipvpn": "internet",
"authentication": false,
"username": "3901KV7-0801@nextpertise.nl",
"password": "pm6mdqvz3a8f",
"primary_ipv4": "212.57.50.17/32",
"routed_ipv4": [],
"accesslist": null
},
"provisioning_type": "ppp"
}
],
"supplier": "KPNWBA",
"contract_period": {
"to": "2022-08-02",
"from": "2021-08-02",
"last_change": "2021-08-02"
},
"contract_duration": 12,
"location_contacts": [
{
"name": "Contact 1",
"uuid": "2182a44f-aff5-4ef6-8139-52a875c70f6f",
"email": null,
"primary": true,
"phonenumber": "0656565643"
}
],
"transaction": {
"uuid": "db320536-5484-4442-820f-1b125569820b",
"action": "change",
"state": "processing"
}
},
"document_after_transaction": {
"sla": {
"product": {
"name": "24x7",
"supplier": "KPNWBA",
"description": "KPNWBA 24x7 - Premium (FTT[H/O])",
"product_id": 759
},
"order_date": "2021-08-02"
},
"location_contacts": [
{
"name": "Contact 1",
"uuid": "2182a44f-aff5-4ef6-8139-52a875c70f6f",
"email": null,
"primary": true,
"phonenumber": "0656565643"
}
],
"enduser": {
"uuid": "17a0ac8b-c6ae-4a2d-aa97-2554244ae6ac"
},
"carrier": {
"nid": "3901KV000070800",
"tags": [],
"product": {
"name": "W-ADSL-WN/Fiber/GoF/MIGRATE_FTTH",
"aggregated_carriertype": "Fiber",
"upload": null,
"carriertype": "Fiber",
"copper_pairs": 1,
"base_technology": "FttH",
"nlstype": "FMIGRATE",
"data_technology": "GoF",
"maxnls": null,
"estimated_delivery_duration": "10d",
"test_label": false,
"active": true,
"product_id": 636,
"channel_type": "Ethernet",
"distance": null,
"supplier": "KPNWBA",
"aggregated_data_technology": "Fiber",
"area": null,
"download": null
},
"ftu_type": "FTU_TK01",
"serviceid": "HQE73515"
},
"supplier": "KPNWBA",
"active": true,
"circuits": [
{
"nid": "3901KV000070801",
"vlan": 6,
"product": {
"download": 100000,
"supplier": "KPNWBA",
"overbooking": 0,
"service_type": 7396,
"active": true,
"is_pvc": true,
"upload": 100000,
"name": null,
"product_id": 279,
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "REGULAR",
"area": null
},
"provisioning": {
"ipvpn": "internet",
"authentication": false
},
"provisioning_type": "ppp"
}
],
"address": {
"province": "Utrecht",
"municipality": "Veenendaal",
"city": "Veenendaal",
"street": "De Brinken",
"housenr": 7,
"housenrext": "",
"latitude": "52.0199694",
"longitude": "5.5612248",
"zipcode": "3901KV"
},
"contract_period": {
"from": null,
"to": null,
"last_change": null
},
"contract_duration": 12
}
}
}
JSON-RPC
check_authentication()
Since v1.18.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| username | string | |
| password | string |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "check_authentication",
"params": {
"username": "testing@example.com",
"password": "password"
}
}
Reply example
{
"result": "Mon Apr 13 10:02:48 CEST 2020\nSent Access-Request\n\tUser-Name = \"testing@example.com\"\n\tUser-Password = \"password\"\n\tFramed-Protocol = \"PPP\"\nReceived Access-Reject\n",
"jsonrpc": "2.0",
"id": 1
}
JSON-RPC
list_available_subnetsizes()
Since v1.25.0
Returns a list of available subnetsizes for an IPVPN.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| ipvpn_name | string | |
| circuit_nid | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| available_subnetsizes | array | |
| available_subnetsizes[#] | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_available_subnetsizes",
"params": {
"ipvpn_name": "internet3"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"available_subnetsizes": [
31,
32
]
}
}
JSON-RPC
get_carrier_products()
Since v1.27.0
Returns available products for a given carrier
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| carrier | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| circuits | array | |
| circuits[#] | object | |
| active | boolean | |
| is_pvc | boolean | |
| area | string, null | A string or no value at all. |
| qos | string, null | A string or no value at all. |
| name | string, null | A string or no value at all. |
| upload | integer, null | An integer or no value at all. |
| quality | string, null | A string or no value at all. |
| download | integer, null | An integer or no value at all. |
| supplier | string | |
| product_id | integer | |
| overbooking | integer, null | An integer or no value at all. |
| slas | array | |
| slas[#] | object | |
| name | string | |
| supplier | string | |
| product_id | integer | |
| description | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_carrier_products",
"params": {
"carrier": 761
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"circuits": [
{
"upload": 51200,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "REGULAR",
"download": 51200,
"product_id": 762,
"overbooking": null
},
{
"upload": 102400,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "REGULAR",
"download": 102400,
"product_id": 763,
"overbooking": null
},
{
"upload": 204800,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "REGULAR",
"download": 204800,
"product_id": 764,
"overbooking": null
},
{
"upload": 512000,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "REGULAR",
"download": 512000,
"product_id": 765,
"overbooking": null
},
{
"upload": 1024000,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "REGULAR",
"download": 1024000,
"product_id": 766,
"overbooking": null
},
{
"upload": 2048,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "PREMIUM",
"download": 2048,
"product_id": 767,
"overbooking": null
},
{
"upload": 1024,
"name": null,
"supplier": "ZIGGO",
"qos": null,
"quality": "PREMIUM",
"download": 1024,
"product_id": 768,
"overbooking": null
}
],
"slas": [
{
"name": "Standard SLA",
"product_id": 760,
"description": "ZIGGO Standard",
"supplier": "ZIGGO"
}
]
}
}
JSON-RPC
get_change_connection_options()
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| carrier_product_ids | array | |
| carrier_product_ids[#] | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| carrier_products | object | |
| ^\d+$ | enum | Enum options:new|realtime|planned. undefined |
Examples
JSON-RPC
list_contract_durations()
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| filter | object | |
| carrier_product_id | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| ^[1-9][0-9]+$ | array | |
| ^[1-9][0-9]+$[#] | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_contract_durations",
"params": {
"filter": {
"carrier_product_id": 108
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"108": [
12
]
}
}
JSON-RPC
get_accesslist()
Since v1.20.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| name | string | |
| circuit_nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| name | string | |
| raw | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_accesslist",
"params": {
"name": "yourplatform"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"name": "yourplatform",
"raw": "\nip:inacl#10=permit ip {{ primary_ipv4_address }} {{ primary_ipv4_wildcard }} 1.2.3.0 0.0.0.255\n ip:inacl#11=permit ip {{ primary_ipv4_address }} {{ primary_ipv4_wildcard }} 4.5.6.0 0.0.0.255\n ip:inacl#13=permit ip {{ primary_ipv4_address }} {{ primary_ipv4_wildcard }} host 5.6.7.8\n ip:inacl#99=deny ip any any"
}
}
JSON-RPC
get_provider_products()
Since v1.27.0
Returns available products for a given provider
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| provider | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| carriers | array | |
| carriers[#] | object | |
| area | string, null | A string or no value at all. |
| name | string | |
| upload | integer, null | An integer or no value at all. |
| nlstype | string, null | A string or no value at all. |
| maxnls | integer, null | An integer or no value at all. |
| distance | string, null | A string or no value at all. |
| download | integer, null | An integer or no value at all. |
| supplier | string | |
| network | string | |
| product_id | integer | |
| test_label | boolean, null | |
| carriertype | enum | Enum options:Copper|Copper_shared|Copper_only|BCopper_only|Fiber|FttH|FttO|Radio. 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. |
| copper_pairs | integer, null | An integer or no value at all. |
| base_technology | string, null | A string or no value at all. |
| data_technology | string, null | A string or no value at all. |
| channel_type | string, null | |
| aggregated_carriertype | string, null | |
| aggregated_data_technology | string, null | |
| netcode_id | integer, null |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_provider_products",
"params": {
"provider": "TELE2"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"carriers": [
{
"upload": null,
"base_technology": "POTS",
"network": "TELE2",
"copper_pairs": 1,
"data_technology": "SDSL.bis",
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "Onnet",
"product_id": 665,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "SDSL.bis",
"netcode_id": null,
"download": null,
"name": "SDSL.bis 2-20Mb",
"aggregated_carriertype": "Copper",
"carriertype": "Copper_only"
},
{
"upload": null,
"base_technology": "POTS",
"network": "TELE2",
"copper_pairs": 1,
"data_technology": "SDSL.bis",
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "Nearnet",
"product_id": 673,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "SDSL.bis",
"netcode_id": null,
"download": null,
"name": "SDSL.bis 20Mb (Nearnet)",
"aggregated_carriertype": "Copper",
"carriertype": "Copper_only"
},
{
"upload": 1024000,
"base_technology": "Fiber",
"network": "TELE2",
"copper_pairs": null,
"data_technology": null,
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "1-Onnet",
"product_id": 674,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "Fiber",
"netcode_id": 1,
"download": 1024000,
"name": "Fiber (1-Onnet)",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
},
{
"upload": 1024000,
"base_technology": "Fiber",
"network": "TELE2",
"copper_pairs": null,
"data_technology": null,
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "2-Nearnet",
"product_id": 675,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "Fiber",
"netcode_id": 2,
"download": 1024000,
"name": "Fiber (2-Nearnet)",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
},
{
"upload": 1024000,
"base_technology": "Fiber",
"network": "TELE2",
"copper_pairs": null,
"data_technology": null,
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "3-Nearnet",
"product_id": 676,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "Fiber",
"netcode_id": 3,
"download": 1024000,
"name": "Fiber (3-Nearnet)",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
},
{
"upload": 1024000,
"base_technology": "Fiber",
"network": "EUROFIBER",
"copper_pairs": null,
"data_technology": null,
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "4-Onnet",
"product_id": 677,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "Fiber",
"netcode_id": 4,
"download": 1024000,
"name": "Fiber (4-Onnet)",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
},
{
"upload": 1024000,
"base_technology": "Fiber",
"network": "EUROFIBER",
"copper_pairs": null,
"data_technology": null,
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "4-Nearnet",
"product_id": 678,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "Fiber",
"netcode_id": 5,
"download": 1024000,
"name": "Fiber (4-Nearnet)",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
}
]
}
}
JSON-RPC
get_recent_transaction()
Since v1.26.0
Get a broadband transaction.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| uuid | string | |
| action | enum | Enum options:offer|new|migrate|change|terminate|migrate_out. undefined |
| open | boolean | |
| state | enum | Enum options:new|processing|finished|cancelled. undefined |
| last_updated | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| sitesurvey_plan_date | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_plan_date | null, one of | |
| sitesurvey_date_replan | boolean, null | |
| sitesurvey_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_executed_date | null, one of | |
| sitesurvey_document | string, null | |
| internalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_plan_date | null, one of | |
| internalworks_date_replan | boolean, null | |
| internalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_executed_date | null, one of | |
| externalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_plan_date | null, one of | |
| externalworks_date_replan | boolean, null | |
| externalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_executed_date | null, one of | |
| expected_completion_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date | null, one of | |
| expected_completion_date_delayed | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date_delayed | null, one of | |
| expected_completion_date_is_forecast | boolean, null | |
| expected_completion_date_replan | boolean, null | |
| customer_wish_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| customer_wish_date | null, one of | |
| customer_wish_date_replan | boolean, null | |
| cancelled_by | string, null | |
| cancel_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cancel_date | null, one of | |
| cancel_reason | string, null | |
| cancel_possible | boolean | |
| replan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| replan_date | null, one of | |
| replan_requested | boolean | |
| cleanorder_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cleanorder_executed_date | null, one of | |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| cancel_requested | boolean, null | |
| document_before_transaction | null, object | |
| document_after_transaction | null, object | |
| document | null, object | |
| ftu_count | null, integer | |
| appointment_url | string, null | |
| replan_possible | boolean | |
| is_complex | boolean, null | |
| is_realtime | boolean, null | |
| closed_at | string, null | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| closed_at | null, one of |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_recent_transaction",
"params": {
"nid": "2408ZE000060100"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"uuid": "7119168a-242d-4e6d-bd76-a885b9a16723",
"nid": "2408ZE000060100",
"action": "terminate",
"state": "new",
"open": true,
"created_at": "2021-07-28T15:29:55Z",
"last_updated": "2021-07-28T15:29:55Z",
"customer_wish_date": "2021-07-28",
"document_before_transaction": {
"sla": {
"product": {
"name": "Best Effort",
"supplier": "KPNWBA",
"product_id": 606,
"description": "KPNWBA Best Effort - Standard (Copper)"
},
"order_date": "2021-07-28"
},
"active": false,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 6,
"zipcode": "2408ZE",
"latitude": "52.1265736",
"province": "Zuid-Holland",
"longitude": "4.6533857",
"housenrext": "",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000060100",
"tags": [],
"israpin": 3,
"product": {
"area": null,
"name": "DLM-WN/Copper_only/VDSL2_POTS/NLS1_ZTL",
"active": true,
"maxnls": 1,
"upload": null,
"nlstype": "NLS1",
"distance": null,
"download": null,
"supplier": "KPNWBA",
"product_id": 118,
"test_label": false,
"carriertype": "Copper_only",
"channel_type": "Ethernet",
"copper_pairs": 1,
"base_technology": "POTS",
"data_technology": "VDSL2",
"aggregated_carriertype": "Copper",
"aggregated_data_technology": "VDSL",
"estimated_delivery_duration": "6d"
},
"additional_israpin": 3
},
"enduser": {
"uuid": "30b8f9ba-7dd1-4626-aed5-a6a2541bc08d"
},
"circuits": [
{
"nid": "2408ZE000060101",
"port": 3,
"tags": [],
"vlan": 3,
"q_in_q": true,
"product": {
"qos": "Premium",
"area": null,
"name": null,
"active": true,
"is_pvc": true,
"upload": 10240,
"quality": "PREMIUM",
"download": 10240,
"supplier": "KPNWBA",
"product_id": 257,
"overbooking": 0,
"service_type": 8710,
"transport_instance": "TI-NEXT/2"
},
"port_speed": "10Mb",
"port_duplex": "half",
"provisioning": {
"enabled": true,
"blocked": false,
"ipvpn": "internet",
"authentication": false,
"username": "2408ZE6-0101@nextpertise.nl",
"password": "bz3aahmmr9ts",
"primary_ipv4": "212.57.50.6/32",
"routed_ipv4": [],
"accesslist": null
},
"provisioning_type": "ppp"
}
],
"supplier": "KPNWBA",
"contract_period": {
"to": null,
"from": null,
"last_change": null
},
"contract_duration": 24,
"location_contacts": [
{
"name": "Romna",
"uuid": "dadf835e-6c18-4cc5-8f2f-9b702fcae88a",
"email": null,
"primary": true,
"phonenumber": "0656565656"
}
],
"transaction": {
"uuid": "7119168a-242d-4e6d-bd76-a885b9a16723",
"action": "terminate",
"state": "new"
}
},
"document_after_transaction": {
"sla": {
"product": {
"name": "Best Effort",
"supplier": "KPNWBA",
"product_id": 606,
"description": "KPNWBA Best Effort - Standard (Copper)"
},
"order_date": "2021-07-28"
},
"active": false,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 6,
"zipcode": "2408ZE",
"latitude": "52.1265736",
"province": "Zuid-Holland",
"longitude": "4.6533857",
"housenrext": "",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000060100",
"tags": [],
"israpin": 3,
"product": {
"area": null,
"name": "DLM-WN/Copper_only/VDSL2_POTS/NLS1_ZTL",
"active": true,
"maxnls": 1,
"upload": null,
"nlstype": "NLS1",
"distance": null,
"download": null,
"supplier": "KPNWBA",
"product_id": 118,
"test_label": false,
"carriertype": "Copper_only",
"channel_type": "Ethernet",
"copper_pairs": 1,
"base_technology": "POTS",
"data_technology": "VDSL2",
"aggregated_carriertype": "Copper",
"aggregated_data_technology": "VDSL",
"estimated_delivery_duration": "6d"
},
"additional_israpin": 3
},
"enduser": {
"uuid": "30b8f9ba-7dd1-4626-aed5-a6a2541bc08d"
},
"circuits": [
{
"nid": "2408ZE000060101",
"port": 3,
"tags": [],
"vlan": 3,
"q_in_q": true,
"product": {
"qos": "Premium",
"area": null,
"name": null,
"active": true,
"is_pvc": true,
"upload": 10240,
"quality": "PREMIUM",
"download": 10240,
"supplier": "KPNWBA",
"product_id": 257,
"overbooking": 0,
"service_type": 8710,
"transport_instance": "TI-NEXT/2"
},
"port_speed": "10Mb",
"port_duplex": "half",
"provisioning": {
"ipvpn": "internet",
"authentication": false
},
"provisioning_type": "ppp"
}
],
"supplier": "KPNWBA",
"transaction": {
"uuid": null,
"state": null,
"action": null
},
"contract_period": {
"to": null,
"from": null,
"last_change": null
},
"contract_duration": 24,
"location_contacts": [
{
"name": "Neo",
"uuid": "dadf835e-6c18-4cc5-8f2f-9b702fcae88a",
"email": null,
"primary": true,
"phonenumber": "0656565656"
}
]
}
}
}
JSON-RPC
get_transaction()
Since v1.24.0
Get a broadband transaction.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| uuid | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| uuid | string | |
| action | enum | Enum options:offer|new|migrate|change|terminate|migrate_out. undefined |
| open | boolean | |
| state | enum | Enum options:new|processing|finished|cancelled. undefined |
| last_updated | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| sitesurvey_plan_date | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_plan_date | null, one of | |
| sitesurvey_date_replan | boolean, null | |
| sitesurvey_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_executed_date | null, one of | |
| sitesurvey_document | string, null | |
| internalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_plan_date | null, one of | |
| internalworks_date_replan | boolean, null | |
| internalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_executed_date | null, one of | |
| externalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_plan_date | null, one of | |
| externalworks_date_replan | boolean, null | |
| externalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_executed_date | null, one of | |
| expected_completion_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date | null, one of | |
| expected_completion_date_delayed | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date_delayed | null, one of | |
| expected_completion_date_is_forecast | boolean, null | |
| expected_completion_date_replan | boolean, null | |
| customer_wish_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| customer_wish_date | null, one of | |
| customer_wish_date_replan | boolean, null | |
| cancelled_by | string, null | |
| cancel_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cancel_date | null, one of | |
| cancel_reason | string, null | |
| cancel_possible | boolean | |
| replan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| replan_date | null, one of | |
| replan_requested | boolean | |
| cleanorder_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cleanorder_executed_date | null, one of | |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| cancel_requested | boolean, null | |
| document_before_transaction | null, object | |
| document_after_transaction | null, object | |
| document | null, object | |
| ftu_count | null, integer | |
| appointment_url | string, null | |
| replan_possible | boolean | |
| is_complex | boolean, null | |
| is_realtime | boolean, null | |
| closed_at | string, null | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| closed_at | null, one of |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_transaction",
"params": {
"uuid": "3b5695fa17294d85b5481d4a5814af71"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"uuid": "3b5695fa17294d85b5481d4a5814af71",
"nid": "1058TM000610100",
"action": "new",
"state": "finished",
"open": false,
"created_at": "2020-11-18T19:22:28Z",
"last_updated": "2021-01-11T17:03:05Z",
"expected_completion_date": "2019-07-12",
"document_after_transaction": {
"sla": {
"product": {
"name": "Best Effort SLA",
"supplier": "KPNWBA",
"product_id": 606,
"description": "KPNWBA Best Effort - Standard (Copper)"
},
"order_date": "2020-03-22"
},
"active": true,
"address": {
"city": "Amsterdam",
"street": "Westlandgracht",
"housenr": 61,
"zipcode": "1058TM",
"latitude": "52.3536089",
"province": "Noord-Holland",
"longitude": "4.8461436",
"housenrext": "2",
"municipality": "Amsterdam"
},
"carrier": {
"nid": "1058TM000610100",
"tags": [
"Teun",
"Thuis",
"company=Teun Ouwehand thuis"
],
"product": {
"area": null,
"name": "W-ADSL-WN/Fiber/GPON/MIGRATE_FTTH",
"active": true,
"upload": null,
"nlstype": "FMIGRATE",
"distance": null,
"download": null,
"supplier": "KPNWBA",
"product_id": 774,
"test_label": false,
"carriertype": "Fiber",
"copper_pairs": 1,
"base_technology": "FttH",
"data_technology": "GPON",
"estimated_delivery_duration": "18d"
}
},
"enduser": {
"uuid": "a64889f7-63ea-4c1c-8ccb-ec28904496a7"
},
"circuits": [
{
"nid": "1058TM000610101",
"tags": [
"Data"
],
"vlan": "6",
"product": {
"qos": "Best Effort",
"area": null,
"name": null,
"active": true,
"is_pvc": true,
"upload": 30720,
"quality": "REGULAR",
"download": 102400,
"supplier": "KPNWBA",
"product_id": 755,
"overbooking": 0,
"service_type": 8419,
"transport_instance": "TI-NEXT/1",
"waiting_for_kpnwba_rectification": false
},
"provisioning_type": "ppp"
},
{
"nid": "1058TM000610102",
"tags": [],
"vlan": "7",
"product": {
"qos": "Premium",
"area": null,
"name": null,
"active": true,
"is_pvc": true,
"upload": 256,
"quality": "PREMIUM",
"download": 256,
"supplier": "KPNWBA",
"product_id": 332,
"overbooking": 0,
"service_type": 8608,
"transport_instance": "TI-NEXT/2",
"waiting_for_kpnwba_rectification": false
},
"provisioning_type": "ppp"
}
],
"supplier": "KPNWBA",
"contract_period": {
"to": "2021-03-22",
"from": "2019-07-12",
"last_change": "2020-03-22"
},
"contract_duration": 12,
"location_contacts": [
{
"name": "Teun Ouwehand",
"uuid": "e002820611584a3f830efe56c62dfe46",
"email": null,
"primary": true,
"phonenumber": "0628020604"
}
]
}
}
}
JSON-RPC
list_auth_realms()
Since v1.17.0
Show realm's of the current logedin user's company.
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| realm | array | |
| realm[#] | object | |
| id | integer | |
| name | string | |
| default | boolean |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_auth_realms",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"result": {
"realm": [
{
"default": true,
"realm_name": "nextpertise.nl",
"id": 1
},
{
"default": false,
"realm_name": "ipv2.net",
"id": 2
}
]
},
"id": 1
}
JSON-RPC
list_connections()
Since v1.24.0
List all broadband connections. Supports pagination, sorting and filtering.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| pagination | object | Used to limit the amount of items returned. |
| per_page | integer | Amount of items per page. |
| page | integer | The requested page-index, starts at 1. |
| filter | object | Select relevant connections by using one or more of the filter properties. |
| nid | string | Connection (carrier/circuit) nid |
| carrier_nid | string | Connection carrier nid |
| circuit_nid | string | Connection circuit nid |
| carrier_tags | string | Connection carrier tag |
| circuit_tags | string | Connection circuit tag |
| state | array | The status of the broadband connections must have one of the given values. |
| state[#] | enum | Enum options:PROCESSING|ACTIVE|TERMINATED|CANCELLED. undefined |
| street | string | Select connections where (part of) the street name matches the given value. |
| housenr | string | Select connections where (part of) the house number matches the given value. |
| housenrext | string | Select connections where (part of) the house number extension matches the given value. |
| zipcode | string | Select connections where (part of) the zipcode matches the given value. |
| city | string | Select connections where (part of) the city name matches the given value. |
| auth_user | string | Select connections where (part of) the RADIUS user name matches the given value. |
| ipv4 | string | Select connections where (part of) the IPv4 address matches the given value. |
| sla | string | Select connections where (part of) the SLA name matches the given value. |
| supplier | string | Select connections where (part of) the supplier name matches the given value. |
| base_technology | string | Select connections where (part of) the base technology name matches the given value. |
| data_technology | string | Select connections where (part of) the data technology name matches the given value. |
| online | enum | Enum options:online|offline|unknown. Select connections where the online status matches one or more of the array elements. |
| active | boolean | Select connections which are administratively active. |
| username | string | Select connections which username (login or authentication username) |
| ip | string | Check if IP equal last_ipv4 or present in one of the IP range: primary_ipv4, routed_ipv4 |
| serviceid | string | Search on KPNWBA serviceid. |
| enduser_uuid | string | Filter on enduser UUID. |
| has_end_of_life_date | boolean | Select connections with an end of life date set. |
| end_of_life_date | string | Regex:^[0-9-]+$. Prefix filter on end of life date. |
| end_of_life_reason | string | |
| sort | object | |
| state | enum | Enum options:ASC|DESC. undefined |
| street | enum | Enum options:ASC|DESC. undefined |
| housenr | enum | Enum options:ASC|DESC. undefined |
| housenrext | enum | Enum options:ASC|DESC. undefined |
| zipcode | enum | Enum options:ASC|DESC. undefined |
| city | enum | Enum options:ASC|DESC. undefined |
| primary_ipv4 | enum | Enum options:ASC|DESC. undefined |
| sla | enum | Enum options:ASC|DESC. undefined |
| supplier | enum | Enum options:ASC|DESC. undefined |
| base_technology | enum | Enum options:ASC|DESC. undefined |
| data_technology | enum | Enum options:ASC|DESC. undefined |
| active | enum | Enum options:ASC|DESC. undefined |
| online | enum | Enum options:ASC|DESC. undefined |
| end_of_life_date | enum | Enum options:ASC|DESC. undefined |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| connections | array | |
| connections[#] | object | |
| sla | object | |
| order_date | string | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| product | object | |
| name | string | |
| supplier | string | |
| product_id | integer | |
| description | string | |
| active | boolean | |
| address | object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null | |
| carrier | object | |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| tags | array | |
| tags[#] | string | |
| product | object | |
| area | string, null | A string or no value at all. |
| name | string | |
| upload | integer, null | An integer or no value at all. |
| nlstype | string, null | A string or no value at all. |
| maxnls | integer, null | An integer or no value at all. |
| distance | string, null | A string or no value at all. |
| download | integer, null | An integer or no value at all. |
| supplier | string | |
| network | string | |
| product_id | integer | |
| test_label | boolean, null | |
| carriertype | enum | Enum options:Copper|Copper_shared|Copper_only|BCopper_only|Fiber|FttH|FttO|Radio. 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. |
| copper_pairs | integer, null | An integer or no value at all. |
| base_technology | string, null | A string or no value at all. |
| data_technology | string, null | A string or no value at all. |
| channel_type | string, null | |
| aggregated_carriertype | string, null | |
| aggregated_data_technology | string, null | |
| netcode_id | integer, null | |
| contract_duration | integer | |
| provider_order_number | string, null | A string or no value at all. |
| upstream_billing_date | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| upstream_billing_date | null, one of | |
| israspecs | string, null | A string or no value at all. |
| israpin | integer, null | |
| additional_israpin | integer, null | |
| servicegroup | string, null | |
| serviceid | string, null | |
| additional_serviceid | string, null | |
| fiber_terminationpoint_id | string, null | |
| ftu_type | string, null | |
| ftu_count | integer, null | |
| distribution_frame | string, null | |
| enduser | object | |
| uuid | string | |
| circuits | array | |
| circuits[#] | object | |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| tags | array | |
| tags[#] | string | |
| vlan | integer, string, null | |
| port | integer | |
| q_in_q | boolean | |
| product | object | |
| active | boolean | |
| is_pvc | boolean | |
| area | string, null | A string or no value at all. |
| qos | string, null | A string or no value at all. |
| name | string, null | A string or no value at all. |
| upload | integer, null | An integer or no value at all. |
| quality | string, null | A string or no value at all. |
| download | integer, null | An integer or no value at all. |
| supplier | string | |
| product_id | integer | |
| overbooking | integer, null | An integer or no value at all. |
| nni_vlan | integer, null | An integer or no value at all. |
| port_speed | string, null | |
| port_duplex | string, null | |
| provisioning | object | |
| enabled | boolean | |
| ipvpn | string, null | A string or no value at all. |
| blocked | boolean | |
| authentication | boolean | |
| username | string | |
| password | string | |
| routed_ipv4 | array | |
| routed_ipv4[#] | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))$. The IPv4 subnet assigned to this circuit in CIDR format |
| accesslist | string, null | Regex:^[a-z0-9_]{3,}$. |
| provisioning_type | string, null | |
| provider_order_number | string, null | A string or no value at all. |
| customer_connection_tag | string, null | A string or no value at all. |
| supplier | string | |
| contract_period | object | |
| to | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| to | null, one of | |
| from | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| from | null, one of | |
| last_change | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| last_change | null, one of | |
| end_of_life_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| end_of_life_date | null, one of | |
| end_of_life_reason | string, null | A string or no value at all. |
| contract_duration | integer | |
| location_contacts | array | |
| location_contacts[#] | object | |
| name | string | |
| uuid | string | |
| string, null | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). |
|
| primary | boolean | |
| phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| transaction | object | |
| uuid | string, null | A string or no value at all. |
| action | string, null | A string or no value at all. |
| state | string, null | A string or no value at all. |
| customer_id | integer | |
| pagination | object | Information about the pagination settings. If a (next|previous)_page returns null, the (next|previous)page does not exist. |
| previous_page | integer, null | An integer or no value at all. |
| next_page | integer, null | An integer or no value at all. |
| per_page | integer | Max amount of tickets per page. |
| count | integer, null | An integer or no value at all. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_connections",
"params": {
"filter": {
"nid": "2408ZE000100100"
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"connections": [
{
"sla": {
"product": {
"name": "Gold SLA",
"supplier": "TELE2",
"product_id": 752,
"description": "TELE2 Gold"
},
"order_date": "2020-11-26"
},
"active": true,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 1,
"zipcode": "2408ZE",
"latitude": "52.1266179",
"province": "Zuid-Holland",
"longitude": "4.654452",
"housenrext": "",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000010100",
"tags": [],
"product": {
"area": null,
"name": "W-ADSL-WN/Fiber/GoF_FTTH/NLS6",
"maxnls": 6,
"upload": null,
"network": "KPNWBA",
"nlstype": "NLS6",
"distance": null,
"download": null,
"supplier": "KPNWBA",
"netcode_id": null,
"product_id": 638,
"test_label": false,
"carriertype": "Fiber",
"channel_type": "Ethernet",
"copper_pairs": 1,
"base_technology": "FttH",
"data_technology": "GoF",
"aggregated_carriertype": "Fiber",
"aggregated_data_technology": "Fiber"
}
},
"enduser": {
"uuid": "17a0ac8b-c6ae-4a2d-aa97-2554244ae6ac"
},
"circuits": [
{
"nid": "2408ZE000010101",
"port": 12,
"tags": [],
"vlan": 12,
"q_in_q": true,
"product": {
"qos": null,
"name": "Premium circuit 1Mb (Metro)",
"upload": 1024,
"quality": "PREMIUM",
"download": 1024,
"supplier": "TELE2",
"product_id": 711,
"overbooking": null
},
"port_speed": "10Mb",
"port_duplex": "half",
"provisioning": {
"enabled": true,
"blocked": false,
"ipvpn": "internet",
"authentication": false,
"username": "2408ZE1-0101@nextpertise.nl",
"password": "9pgxtf8xt364",
"primary_ipv4": "212.57.50.6/32",
"routed_ipv4": [],
"accesslist": null
},
"provisioning_type": "ppp"
}
],
"supplier": "TELE2",
"contract_period": {
"to": null,
"from": null,
"last_change": null
},
"contract_duration": 12,
"location_contacts": [
{
"name": "Roman",
"uuid": "81d6388d-0209-44a7-9f5d-d875f7f47bf0",
"email": null,
"primary": true,
"phonenumber": "0646464643"
}
],
"transaction": {
"uuid": null,
"action": null,
"state": null
}
}
]
}
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_connections",
"params": {
"pagination": {
"per_page": 2,
"page": 1
},
"filter": {
"zipcode": "2408ZE"
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"connections": [
{
"sla": {
"product": {
"name": "Gold SLA",
"supplier": "TELE2",
"product_id": 752,
"description": "TELE2 Gold"
},
"order_date": "2020-11-26"
},
"active": true,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 1,
"zipcode": "2408ZE",
"latitude": "52.1266179",
"province": "Zuid-Holland",
"longitude": "4.654452",
"housenrext": "",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000010100",
"tags": [],
"product": {
"upload": 1024000,
"base_technology": "Fiber",
"network": "TELE2",
"copper_pairs": null,
"data_technology": null,
"nlstype": null,
"maxnls": null,
"test_label": null,
"distance": "1-Onnet",
"product_id": 674,
"channel_type": "Ethernet",
"area": null,
"supplier": "TELE2",
"aggregated_data_technology": "Fiber",
"netcode_id": 1,
"download": 1024000,
"name": "Fiber (1-Onnet)",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
}
},
"enduser": {
"uuid": "17a0ac8b-c6ae-4a2d-aa97-2554244ae6ac"
},
"circuits": [
{
"nid": "2408ZE000010101",
"port": 12,
"tags": [],
"vlan": 12,
"q_in_q": true,
"product": {
"qos": null,
"name": "Premium circuit 1Mb (Metro)",
"upload": 1024,
"quality": "PREMIUM",
"download": 1024,
"supplier": "TELE2",
"product_id": 711,
"overbooking": null
},
"port_speed": "10Mb",
"port_duplex": "half",
"provisioning": {
"enabled": true,
"blocked": false,
"ipvpn": "internet",
"authentication": false,
"username": "2408ZE1-0101@nextpertise.nl",
"password": "9pgxtf8xt364",
"primary_ipv4": "212.57.50.6/32",
"routed_ipv4": [],
"accesslist": null
},
"provisioning_type": "ppp"
}
],
"supplier": "TELE2",
"contract_period": {
"to": null,
"from": null,
"last_change": null
},
"contract_duration": 12,
"location_contacts": [
{
"name": "Roman",
"uuid": "81d6388d-0209-44a7-9f5d-d875f7f47bf0",
"email": null,
"primary": true,
"phonenumber": "0646464643"
}
],
"transaction": {
"uuid": null,
"action": null,
"state": null
}
},
{
"sla": {
"product": {
"name": "Best Effort SLA",
"supplier": "KPNWBA",
"product_id": 758,
"description": "KPNWBA Best Effort - Standard (FTT[H/O])"
},
"order_date": "2020-04-02"
},
"active": true,
"address": {
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 10,
"zipcode": "2408ZE",
"latitude": "52.1266051",
"province": "Zuid-Holland",
"longitude": "4.6533684",
"housenrext": "A",
"municipality": "Alphen aan den Rijn"
},
"carrier": {
"nid": "2408ZE000100200",
"tags": [
"company=next-office"
],
"product": {
"upload": null,
"base_technology": "FttH",
"network": "KPNWBA",
"copper_pairs": 1,
"data_technology": "GoF",
"nlstype": "NLS6",
"maxnls": 6,
"test_label": false,
"distance": null,
"product_id": 638,
"channel_type": "Ethernet",
"area": null,
"supplier": "KPNWBA",
"aggregated_data_technology": "Fiber",
"netcode_id": null,
"download": null,
"name": "W-ADSL-WN/Fiber/GoF_FTTH/NLS6",
"aggregated_carriertype": "Fiber",
"carriertype": "Fiber"
}
},
"enduser": {
"uuid": "c0225608-3ce0-4f9d-a1a6-0e33599c8290"
},
"circuits": [
{
"nid": "2408ZE000100201",
"tags": [],
"vlan": 6,
"product": {
"qos": "Best Effort",
"name": null,
"upload": 100000,
"quality": "REGULAR",
"download": 100000,
"supplier": "KPNWBA",
"product_id": 279,
"overbooking": 0
},
"provisioning_type": "ppp"
},
{
"nid": "2408ZE000100202",
"tags": [],
"vlan": 7,
"product": {
"qos": "Best Effort",
"name": null,
"upload": 100000,
"quality": "REGULAR",
"download": 100000,
"supplier": "KPNWBA",
"product_id": 279,
"overbooking": 0
},
"provisioning_type": "ppp",
"last_ipv4": "185.25.83.30",
"last_username": "jasfo-i001@deanconnect.eu",
"online": "offline"
}
],
"supplier": "KPNWBA",
"contract_period": {
"to": "2021-04-02",
"from": "2015-08-07",
"last_change": "2020-04-02"
},
"contract_duration": 12,
"location_contacts": [
{
"name": "support",
"uuid": "a0fc489ce76845e2becaeef240230fea",
"email": null,
"primary": true,
"phonenumber": "0793317414"
}
],
"transaction": {
"uuid": "506f6779-c042-4df9-a421-c50760f8e94b",
"action": "change",
"state": "processing"
}
}
],
"pagination": {
"previous_page": null,
"next_page": 2,
"per_page": 2,
"count": 4
}
}
}
JSON-RPC
list_events()
Since v1.20.0
Lists events
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| filter | object | |
| uuid | string, one of | |
| nid | string, null, one of | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| transaction_uuid | string, one of | |
| type | string, one of | |
| is_audit_event | boolean, one of | |
| pagination | object | Used to limit the amount of items returned. |
| per_page | integer | Amount of items per page. |
| page | integer | The requested page-index, starts at 1. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| events | array | |
| events[#] | object | |
| uuid | string | |
| type | enum | Enum options:notification|async_event|apirequest|broadband_event. Enum containing all possible event types. |
| cid | string, null | A string or no value at all. |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| transaction_uuid | string, null | A string or no value at all. |
| method | string, null | A string or no value at all. |
| request | object, null | |
| username | string, null | A string or no value at all. |
| recipient | string, null | A string or no value at all. |
| action | string, null | A string or no value at all. |
| response | object, string, null | |
| datetime | string | |
| transaction_action | string, null | |
| notifications | array | |
| notifications[#] | object | |
| recipient | string | |
| attachment | object, null | |
| url | string | |
| event_properties | null, object | |
| kpnwba_comment_codes | array | |
| kpnwba_comment_codes[#] | object | |
| code | integer | |
| description | string | |
| order_note | string | |
| kpnwba_error_code | object | |
| code | integer | |
| description | string | |
| pagination | object | Information about the pagination settings. If a (next|previous)_page returns null, the (next|previous)page does not exist. |
| previous_page | integer, null | An integer or no value at all. |
| next_page | integer, null | An integer or no value at all. |
| per_page | integer | Max amount of tickets per page. |
| count | integer, null | An integer or no value at all. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_events",
"params": {
"filter": {
"nid": "2408ZE000100200"
}
}
}
Reply example
{
"result": {
"events": [
{
"uuid": "0e71dc30-62fd-11ec-a664-111111111111",
"action": null,
"request": {
"custwishdate": null,
"contact_name": "Teun Ouwehand",
"cpe": [],
"zipcode": "2408ZE",
"additional_contact_phonenumber": null,
"contact_phonenumber": "0887775200",
"confirm": {
"Terminate Voice": false
},
"company": "Nextpertise",
"requested_phonenumber": null,
"serviceid": "",
"circuit": [
{
"circuit": 272,
"vlan": 6
}
],
"housenrext": "",
"contract_duration": 12,
"isra": "001//MTK/METERKAST",
"carrier": 118,
"housenr": 10,
"tags": [],
"sla": 606
},
"datetime": "2020-04-15T11:49:55",
"recipient": null,
"method": "broadband.order_connection",
"cid": "83d71d5d-e07c-4061-8f8e-5a3b91a31a14",
"type": "apirequest",
"nid": "2408ZE000100200",
"username": "teun@nextpertise.nl",
"response": {
"orderid": "2408ZE000100200"
}
}
]
},
"jsonrpc": "2.0",
"id": 1
}
JSON-RPC
list_accesslists()
Since v1.20.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| name | string | |
| circuit_nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| accesslists | array | |
| accesslists[#] | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_accesslists",
"params": {
"name": "internet"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"accesslists": [
"yourplatform",
"broadworks"
]
}
}
JSON-RPC
list_ipvpns()
Since v1.20.0
Overview of ipvpns, ipranges, reservations and dns settings of the current user's company. Shared ip pools are returned with limited information.
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| ipvpns | array | |
| ipvpns[#] | object | |
| id | integer | |
| name | string | |
| vrf | string | |
| default | boolean | |
| loopback | string, null | |
| default_subnetsize | integer, null | |
| min_subnetsize | integer, null | |
| max_subnetsize | integer, null | |
| max_number_of_entries_in_accesslist | integer | |
| ipv4_dns1 | string, null | |
| ipv4_dns2 | string, null | |
| radius_server1 | string, null | |
| radius_server2 | string, null | |
| radius_secret | string, null | |
| radius_managed | boolean, null | |
| radius_authentication | boolean, null | |
| l2tp_lac_vrf | string, null | |
| l2tp_lns_ipaddresses | string, null | |
| l2tp_tunnel_password | string, null | |
| pool | array | |
| pool[#] | object | Shared pools have limited information available. |
| id | integer | |
| priority | integer | |
| shared | boolean | |
| description | string | |
| network | string | |
| subnetsize | integer | |
| exclude | array | |
| exclude[#] | object | |
| id | integer | |
| description | string | |
| network | string | |
| subnetsize | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_ipvpns",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"ipvpns": [
{
"ipv4_dns2": "195.238.87.155",
"l2tp_tunnel_password": null,
"loopback": "Loopback3012",
"id": 2,
"default_subnetsize": 32,
"radius_managed": true,
"vrf": "vpn01-internet",
"max_subnetsize": 30,
"radius_server1": "",
"name": "internet",
"radius_server2": "",
"radius_secret": "",
"default": true,
"radius_authentication": false,
"ipv4_dns1": "195.238.86.155",
"l2tp_lac_vrf": null,
"l2tp_lns_ipaddresses": null,
"pool": [
{
"shared": true,
"id": 2,
"description": "Shared Internet Block 1",
"priority": 1
},
{
"shared": false,
"subnetsize": 24,
"id": 1,
"description": "Example Internet block 1",
"network": "212.57.63.0",
"priority": 2,
"exclude": [
{
"description": "Example Exclude 1",
"network": "212.57.63.138",
"id": 61,
"subnetsize": 32
},
{
"description": "Example Exclude 2",
"network": "212.57.63.102",
"id": 63,
"subnetsize": 32
}
]
}
]
},
{
"ipv4_dns2": "195.238.87.155",
"l2tp_tunnel_password": null,
"loopback": "Loopback3052",
"id": 4,
"default_subnetsize": 32,
"radius_managed": false,
"vrf": "vpn05-failover",
"max_subnetsize": 30,
"radius_server1": null,
"name": "vpn05-failover",
"radius_server2": null,
"radius_secret": null,
"default": false,
"radius_authentication": null,
"ipv4_dns1": "195.238.86.155",
"l2tp_lac_vrf": null,
"l2tp_lns_ipaddresses": null,
"pool": []
}
]
}
}
JSON-RPC
list_providers()
Since v1.16.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| include_providers_without_zipcode_check | boolean |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| providers | array | |
| providers[#] | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_providers",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"providers": [
"KPNWBA",
"KPNWEAS",
"EUROFIBER",
"TELE2",
"ZIGGO"
]
}
}
JSON-RPC
list_transactions()
Since v1.24.0
List all broadband transactions. Supports pagination, sorting and filtering.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| pagination | object | Used to limit the amount of transactions returned. |
| per_page | integer | Amount of transactions per page (request). |
| page | integer | The requested page-index, starts at 1. |
| filter | object | Filter transactions. The key is the column and the value is your search. |
| uuid | string | |
| nid | string | |
| action | enum | Enum options:offer|new|migrate|change|terminate|migrate_out. undefined |
| open | boolean | |
| state | enum | Enum options:new|processing|finished|cancelled. undefined |
| last_updated | string | |
| sitesurvey_plan_date | string | |
| sitesurvey_date_replan | boolean, null | |
| expected_completion_date | string | |
| expected_completion_date_is_forecast | boolean, null | |
| expected_completion_date_replan | boolean, null | |
| expected_completion_date_delayed | string | |
| permit | string, null | |
| cancel_reason | string | |
| cancelled_by | string, null | |
| ftu_count | integer | |
| appointment_url | string, null | |
| sort | object | Sort transactions. By default, transactions are sorted in order of creation. |
| uuid | enum | Enum options:ASC|DESC. undefined |
| nid | enum | Enum options:ASC|DESC. undefined |
| action | enum | Enum options:ASC|DESC. undefined |
| open | enum | Enum options:ASC|DESC. undefined |
| state | enum | Enum options:ASC|DESC. undefined |
| last_updated | enum | Enum options:ASC|DESC. undefined |
| sitesurvey_plan_date | enum | Enum options:ASC|DESC. undefined |
| sitesurvey_date_replan | enum | Enum options:ASC|DESC. undefined |
| expected_completion_date | enum | Enum options:ASC|DESC. undefined |
| expected_completion_date_is_forecast | enum | Enum options:ASC|DESC. undefined |
| expected_completion_date_replan | enum | Enum options:ASC|DESC. undefined |
| expected_completion_date_delayed | enum | Enum options:ASC|DESC. undefined |
| permit | enum | Enum options:ASC|DESC. undefined |
| cancel_reason | enum | Enum options:ASC|DESC. undefined |
| cancelled_by | enum | Enum options:ASC|DESC. undefined |
| ftu_count | enum | Enum options:ASC|DESC. undefined |
| appointment_url | enum | Enum options:ASC|DESC. undefined |
| document | array | If given, adds the document. Keys added to the list will be extended in the document. Supported keys: 'enduser' |
| document[#] | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| transactions | array | The transaction list |
| transactions[#] | object | |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| uuid | string | |
| action | enum | Enum options:offer|new|migrate|change|terminate|migrate_out. undefined |
| open | boolean | |
| state | enum | Enum options:new|processing|finished|cancelled. undefined |
| last_updated | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| sitesurvey_plan_date | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_plan_date | null, one of | |
| sitesurvey_date_replan | boolean, null | |
| sitesurvey_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| sitesurvey_executed_date | null, one of | |
| sitesurvey_document | string, null | |
| internalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_plan_date | null, one of | |
| internalworks_date_replan | boolean, null | |
| internalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| internalworks_executed_date | null, one of | |
| externalworks_plan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_plan_date | null, one of | |
| externalworks_date_replan | boolean, null | |
| externalworks_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| externalworks_executed_date | null, one of | |
| expected_completion_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date | null, one of | |
| expected_completion_date_delayed | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| expected_completion_date_delayed | null, one of | |
| expected_completion_date_is_forecast | boolean, null | |
| expected_completion_date_replan | boolean, null | |
| customer_wish_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| customer_wish_date | null, one of | |
| customer_wish_date_replan | boolean, null | |
| cancelled_by | string, null | |
| cancel_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cancel_date | null, one of | |
| cancel_reason | string, null | |
| cancel_possible | boolean | |
| replan_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| replan_date | null, one of | |
| replan_requested | boolean | |
| cleanorder_executed_date | string, null, one of | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| cleanorder_executed_date | null, one of | |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| cancel_requested | boolean, null | |
| document_before_transaction | null, object | |
| document_after_transaction | null, object | |
| document | null, object | |
| ftu_count | null, integer | |
| appointment_url | string, null | |
| replan_possible | boolean | |
| is_complex | boolean, null | |
| is_realtime | boolean, null | |
| closed_at | string, null | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| closed_at | null, one of | |
| pagination | object | Information about the pagination settings. If a (next|prev)_page returns null, the page does not exist. |
| previous_page | integer, null | An integer or no value at all. |
| next_page | integer, null | An integer or no value at all. |
| per_page | integer | Max amount of tickets per page. |
| count | integer, null | An integer or no value at all. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_transactions",
"params": {
"pagination": {
"per_page": 50,
"page": 1
},
"sort": {
"nid": "DESC"
},
"filter": {
"action": "new"
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"transactions": [
{
"uuid": "0b01c0f6-ec1c-436d-a8fc-ccc0793d86c3",
"nid": "3901KV000210300",
"action": "new",
"state": "finished",
"open": false,
"last_updated": "2020-07-14T14:21:39Z",
"created_at": "2020-01-14T14:27:52Z",
"sitesurvey_plan_date": "2020-04-29",
"expected_completion_date": "2020-06-29",
"expected_completion_date_is_forecast": true,
"expected_completion_date_replan": true,
"cancelled_by": null,
"cancel_date": null,
"cancel_reason": null,
"cancel_requested": false
},
{
"uuid": "547f7ca0-c788-455a-8adc-b7f370f372f3",
"nid": "3901KV000210200",
"action": "new",
"state": "finished",
"open": false,
"last_updated": "2020-07-14T14:09:37Z",
"created_at": "2020-03-14T14:27:52Z",
"sitesurvey_plan_date": "2020-05-06",
"sitesurvey_date_replan": null,
"sitesurvey_document": null,
"expected_completion_date": null,
"expected_completion_date_is_forecast": null,
"expected_completion_date_replan": null,
"cancelled_by": null,
"cancel_date": null,
"cancel_reason": null,
"cancel_requested": false
},
{
"uuid": "831a3ff2-b869-4407-8762-4d104c5fb93e",
"nid": "3901KV000210100",
"action": "new",
"state": "new",
"open": true,
"last_updated": "2020-07-14T14:08:26Z",
"created_at": "2020-07-14T14:01:52Z",
"sitesurvey_plan_date": "2020-05-06",
"sitesurvey_date_replan": null,
"sitesurvey_document": null,
"expected_completion_date": null,
"expected_completion_date_is_forecast": null,
"expected_completion_date_replan": null,
"cancelled_by": null,
"cancel_date": null,
"cancel_reason": null,
"cancel_requested": false
}
],
"pagination": {
"count": 3,
"per_page": 50,
"next_page": null,
"prev_page": null
}
}
}
JSON-RPC
migrate_provisioning()
Since v1.20.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| circuit_nid_src | string | |
| circuit_nid_dst | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| provisioning | object | |
| enabled | boolean | |
| ipvpn | string, null | A string or no value at all. |
| blocked | boolean | |
| authentication | boolean | |
| username | string | |
| password | string | |
| routed_ipv4 | array | |
| routed_ipv4[#] | string | |
| accesslist | string, null | Regex:^[a-z0-9_]{3,}$. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "migrate_provisioning",
"params": {
"circuit_nid_src": "2408ZE000020101",
"circuit_nid_dst": "1024MB000160101"
}
}
Reply example
{
"result": {
"provisioning": {
"username": "1024MB000160101@nextpertise.nl",
"primary_ipv4": "1.2.3.4/32",
"accesslist": null,
"enabled": true,
"routed_ipv4": [
"4.5.6.0/30"
],
"authentication": false,
"ipvpn": "vpn01-internet",
"password": "secret01",
"blocked": false
}
},
"jsonrpc": "2.0",
"id": 1
}
JSON-RPC
order_connection()
Since v1.10.0
Order a connection consisting of a carrier, one or more circuits and an SLA
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| isra | string, null | Regex:^[0-9a-zA-Z/(). -?]+$. Copy from the `connectionpoint` name off the :doc:`../broadband/zipcode` reply. |
| carrier | integer | Identifies an individual product by numeric id. |
| circuit | array | |
| circuit[#] | object | |
| circuit | integer | Identifies an individual product by numeric id. |
| tags | array | |
| tags[#] | string | Regex:[a-zA-Z0-9\/=:_-]+. |
| vlan | integer | |
| vci | integer | |
| vpi | integer | |
| sla | null, one of | |
| sla | integer, one of | Identifies an individual product by numeric id. |
| cpe | array | |
| cpe[#] | integer, one of | Identifies an individual product by numeric id. |
| tags | array | |
| tags[#] | string | Regex:[a-zA-Z0-9\/=:_-]+. |
| enduser | object | |
| uuid | string | |
| contact_name | string | |
| contact_phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| contact_email | string, null | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). |
| contract_duration | integer | |
| additional_contact_phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| confirm | object | |
| Terminate Voice | boolean | |
| custwishdate | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| custwishdate | null, one of | |
| requested_phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| serviceid | null, string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| errorcode | integer | |
| commentcode | string | |
| orderid | string | |
| transaction_uuid | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "order_connection",
"params": {
"zipcode": "2408ZE",
"housenr": 9,
"circuit": [
{
"circuit": 272,
"vlan": 6
}
],
"isra": "0/8/MTK/METERKAST",
"serviceid": "",
"requested_phonenumber": null,
"carrier": 633,
"cpe": [],
"enduser": {
"uuid": "abcde900-08e4-4d95-8793-8083660ea700"
},
"contact_phonenumber": "0101234567",
"additional_contact_phonenumber": null,
"contact_name": "Mrs. Your Client",
"sla": 606,
"contract_duration": 12,
"custwishdate": null,
"tags": [],
"confirm": {
"Terminate Voice": false
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"orderid": "2408ZE000090100"
}
}
JSON-RPC
replan_transaction()
Replan order
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| uuid | string | |
| custwishdate | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| custwishdate | null, one of |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "replan_transaction",
"params": {
"uuid": "ce850b8d-1188-49fc-bfb0-5247bf0770a4",
"custwishdate": "2020-04-23"
}
}
Reply example
{
"jsonrpc": "2.0",
"result": {},
"id": 1
}
JSON-RPC
set_accesslist()
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| name | string, null | Regex:^[a-z0-9_]{3,}$. |
| circuit_nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| vpn | string | |
| accesslist | string | |
| default | boolean |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| name | string, null | Regex:^[a-z0-9_]{3,}$. |
| circuit_nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| vpn | string | |
| accesslist | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "set_accesslist",
"params": {
"accesslist": "deny egress 203.0.113.128/30\nallow egress 203.0.113.0/24\nallow egress 233.252.0.5",
"name": "test5",
"vpn": "voice"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"name": "test5",
"circuit_nid": null,
"vpn": "voice",
"accesslist": "deny egress 203.0.113.128/30\nallow egress 203.0.113.0/24\nallow egress 233.252.0.5"
}
}
JSON-RPC
set_enduser()
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| enduser | object | |
| uuid | string, null |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "set_enduser",
"params": {
"nid": "2408ZE000100100",
"enduser": {
"uuid": "abcde123-0123-4abc-9876-012345678912"
}
}
}
Reply example
{
"jsonrpc": "2.0",
"result": {},
"id": 1
}
JSON-RPC
set_provisioning()
Since v1.20.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| provisioning | object | |
| enabled | boolean | |
| ipvpn | string | |
| blocked | boolean | |
| authentication | boolean | |
| username | string | |
| password | string | |
| primary_ipv4 | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))$. The IPv4 subnet assigned to this circuit in CIDR format |
| routed_ipv4 | array | |
| routed_ipv4[#] | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))$. The IPv4 subnet assigned to this circuit in CIDR format |
| accesslist | string, null | Regex:^[a-z0-9_]{3,}$. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| provisioning | object | |
| enabled | boolean | |
| ipvpn | string, null | A string or no value at all. |
| blocked | boolean | |
| authentication | boolean | |
| username | string | |
| password | string | |
| routed_ipv4 | array | |
| routed_ipv4[#] | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))$. The IPv4 subnet assigned to this circuit in CIDR format |
| accesslist | string, null | Regex:^[a-z0-9_]{3,}$. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "set_provisioning",
"params": {
"nid": "2408ZE000100101",
"provisioning": {
"password": "secret01"
}
}
}
Reply example
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"provisioning": {
"routed_ipv4": [
"1.2.3.0/30"
],
"password": "secret01",
"accesslist": null,
"ipvpn": "internet",
"enabled": true,
"username": "2408ZE10-0101@nextpertise.nl",
"authentication": false,
"blocked": false,
"primary_ipv4": "1.2.3.4/32"
}
}
}
JSON-RPC
set_tags()
Since v1.12.0
Assign a set of tags to a product identified by an nid.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| tags | array | |
| tags[#] | string | Regex:[a-zA-Z0-9\/=:_-]+. |
Reply params
open_in_new
This method returns an empty object:
{}Examples
JSON-RPC
terminate_connection()
Terminates RFS connection
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| custwishdate | string, null | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| custwishdate | null, one of |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "terminate_connection",
"params": {
"nid": "2408ZE000100100"
}
}
Reply example
{
"jsonrpc": "2.0",
"result": {},
"id": 1
}
JSON-RPC
zipcode()
Since v1.0.0
Requests an overview of the products available on a specific location.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| filter | object | |
| provider | array | Provider filter |
| provider[#] | enum | Enum options:TELE2|KPNWEAS|KPNWBA|EUROFIBER|ZIGGO. undefined |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| available | object | |
| KPNWBA|KPNWEAS|TELE2|EUROFIBER|ZIGGO | object | |
| carrier | object | |
| ^[0-9]+$ | object | Define a carrier by its product definition and provide a specification. |
| product_id | integer | Identifies an individual product by numeric id. |
| name | string, null | The product name. |
| description | null, string | Describes the product. |
| extrainfo | null, string | Additional information about the product |
| distance | string, null | Optional indication of the non-recurring costs (supplier specific). |
| area | string, null | Optional indication of the recurring costs (supplier specific). |
| carrier_type | enum | Enum options:Copper|Copper_shared|Copper_only|BCopper_only|Fiber|FttH|FttO|Radio. 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. |
| circuits | array | |
| circuits[#] | integer | |
| download | integer | |
| upload | integer | |
| terminate_voice | boolean | If this field is true, you terminate the voice connection when ordering this carrier. |
| cpe | array | |
| cpe[#] | integer | |
| sla | array | |
| sla[#] | integer | |
| wishdate | boolean | Indicates if carrier vendor allows customer wish date. |
| EVC | object | |
| ^[0-9]+$ | object | Define a circuit by its product definition and provide a specification. |
| product_id | integer | Identifies an individual product by numeric id. |
| name | string, null | The product name. |
| description | null, string | Describes the product. |
| extrainfo | null, string | Additional information about the product |
| max_upload | integer | Highest possible upload speed in kb/s |
| max_download | integer | Highest possible download speed in kb/s |
| min_upload | integer | Lowest upload speed in kb/s |
| min_download | integer | Lowest upload speed in kb/s |
| overbooking | integer | |
| quality | enum | Enum options:regular|premium. undefined |
| connectionpoint | object | |
| ^[0-9a-zA-Z/(). -?]+$ | object | |
| ADSL|VDSL|BVDSL|SDSL|Fiber | array | |
| ADSL|VDSL|BVDSL|SDSL|Fiber[#] | integer | |
| nl1lines | integer | Number of lines present at the location |
| nl1lines_available | integer | Number of unassigned lines at the location. Unassigned means that neither telephone nor broadband services are using these lines. |
| nl2lines | integer | |
| available_service | array | Possibly empty list of services and phonenumbers |
| available_service[#] | object | |
| type | integer, null | An integer or no value at all. |
| service | null, string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| available_technology | array | |
| available_technology[#] | enum | Enum options:ADSL|VDSL|BVDSL|SDSL|SDSL.bis|Fiber|VPLUS|BVPLUS. undefined |
| sla | object | |
| ^[0-9]+$ | object | |
| product_id | integer | Identifies an individual product by numeric id. |
| name | string, null | The product name. |
| description | null, string | Describes the product. |
| extrainfo | null, string | Additional information about the product |
| cpe | object | |
| ^[0-9]+$ | object | |
| product_id | integer | Identifies an individual product by numeric id. |
| name | string, null | The product name. |
| description | null, string | Describes the product. |
| extrainfo | null, string | Additional information about the product |
| address | any of, object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null | |
| address | any of, object | |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| error | object | |
| KPNWBA|KPNWEAS|TELE2|EUROFIBER|ZIGGO | object | |
| message | string | |
| code | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "zipcode",
"params": {
"zipcode": "1024MB",
"housenr": 340,
"filter": {
"provider": [
"KPNWBA"
]
}
}
}
Reply example
{
"result": {
"address": {
"latitude": "52.3911892",
"longitude": "4.9637384",
"housenr": 340,
"street": "Hilversumstraat",
"housenrext": null,
"province": "Noord-Holland",
"zipcode": "1024MB",
"municipality": "Amsterdam",
"city": "Amsterdam"
},
"available": {
"KPNWBA": {
"carrier": {
"616": {
"terminate_voice": false,
"product_id": 616,
"sub_technology": "ADSL2+",
"extrainfo": null,
"contract_duration": [
12
],
"estimated_delivery_duration": "50d",
"prices": {},
"download": 14213,
"cpe": [
651
],
"distance": "NLS3;TL",
"name": "ADSL2+ (non-shared line, NLS3)",
"upload": 976,
"carrier_type": "Copper_only",
"description": null,
"sla": [
606,
607,
608
],
"wishdate": true,
"area": "",
"circuits": [
311,
299,
652
],
"data_technology": "ADSL",
"actions": {}
},
"626": {
"terminate_voice": false,
"product_id": 626,
"sub_technology": "VVDSL2",
"extrainfo": null,
"contract_duration": [
12
],
"estimated_delivery_duration": "50d",
"prices": {},
"download": 61914,
"cpe": [
651
],
"distance": "NLS3;TL",
"name": "VVDSL (non-shared line, NLS3)",
"upload": 14201,
"carrier_type": "Copper_only",
"description": null,
"sla": [
606,
607,
608
],
"wishdate": true,
"area": "",
"circuits": [
267,
268,
272,
755,
332,
652,
249,
253,
255,
257,
316
],
"data_technology": "VDSL",
"actions": {}
},
"633": {
"terminate_voice": false,
"product_id": 633,
"sub_technology": "BVVDSL2",
"extrainfo": null,
"contract_duration": [
12
],
"estimated_delivery_duration": "50d",
"prices": {},
"download": 123827,
"cpe": [
651
],
"distance": "NLS3;TL",
"name": "BVVDSL (NLS3)",
"upload": 28401,
"carrier_type": "BCopper_only",
"description": null,
"sla": [
606,
607,
608
],
"wishdate": true,
"area": "",
"circuits": [
268,
272,
754,
332,
652,
249,
253,
255,
257,
258,
316
],
"data_technology": "BVDSL",
"actions": {}
}
},
"cpe": {
"651": {
"name": "Wall outlet",
"product_id": 651,
"description": null,
"extrainfo": null,
"prices": {},
"actions": {}
}
},
"sla": {
"606": {
"name": "Best Effort SLA",
"product_id": 606,
"description": null,
"extrainfo": null,
"prices": {},
"actions": {}
},
"607": {
"name": "Office Hours SLA",
"product_id": 607,
"description": null,
"extrainfo": null,
"prices": {},
"actions": {}
},
"608": {
"name": "24x7 SLA",
"product_id": 608,
"description": null,
"extrainfo": null,
"prices": {},
"actions": {}
}
},
"EVC": {
"249": {
"product_id": 249,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 1Mb/1Mb",
"description": null,
"max_upload": 1024,
"quality": "premium",
"overbooking": 0,
"max_download": 1024,
"actions": {}
},
"253": {
"product_id": 253,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 2Mb/2Mb",
"description": null,
"max_upload": 2048,
"quality": "premium",
"overbooking": 0,
"max_download": 2048,
"actions": {}
},
"255": {
"product_id": 255,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 5Mb/5Mb",
"description": null,
"max_upload": 5120,
"quality": "premium",
"overbooking": 0,
"max_download": 5120,
"actions": {}
},
"257": {
"product_id": 257,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 10Mb/10Mb",
"description": null,
"max_upload": 10240,
"quality": "premium",
"overbooking": 0,
"max_download": 10240,
"actions": {}
},
"258": {
"product_id": 258,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 20Mb/20Mb",
"description": null,
"max_upload": 20480,
"quality": "premium",
"overbooking": 0,
"max_download": 20480,
"actions": {}
},
"267": {
"product_id": 267,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Regular Circuit 20Mb/2Mb",
"description": null,
"max_upload": 2048,
"quality": "regular",
"overbooking": 0,
"max_download": 20480,
"actions": {}
},
"268": {
"product_id": 268,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Regular Circuit 30Mb/3Mb",
"description": null,
"max_upload": 3072,
"quality": "regular",
"overbooking": 0,
"max_download": 30720,
"actions": {}
},
"272": {
"product_id": 272,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Regular Circuit 50Mb/5Mb",
"description": null,
"max_upload": 10240,
"quality": "regular",
"overbooking": 0,
"max_download": 51200,
"actions": {}
},
"299": {
"product_id": 299,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 256Kb/256Kb",
"description": null,
"max_upload": 256,
"quality": "premium",
"overbooking": 0,
"max_download": 256,
"actions": {}
},
"311": {
"product_id": 311,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "GFR Circuit 22Mb/1Mb",
"description": null,
"max_upload": 1024,
"quality": "regular",
"overbooking": 0,
"max_download": 22000,
"actions": {}
},
"316": {
"product_id": 316,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 50Mb/10Mb",
"description": null,
"max_upload": 10240,
"quality": "premium",
"overbooking": 0,
"max_download": 51200,
"actions": {}
},
"332": {
"product_id": 332,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Circuit 256Kb/256Kb",
"description": null,
"max_upload": 256,
"quality": "premium",
"overbooking": 0,
"max_download": 256,
"actions": {}
},
"652": {
"product_id": 652,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Premium Circuit 512Kb/512Kb overbooking 1:1",
"description": null,
"max_upload": 512,
"quality": "premium",
"overbooking": 99999,
"max_download": 512,
"actions": {}
},
"754": {
"product_id": 754,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Regular Circuit 200Mb/60Mb",
"description": null,
"max_upload": 61440,
"quality": "regular",
"overbooking": 0,
"max_download": 204800,
"actions": {}
},
"755": {
"product_id": 755,
"min_download": 0,
"extrainfo": null,
"min_upload": 0,
"prices": {},
"name": "Regular Circuit 100Mb/30Mb",
"description": null,
"max_upload": 30720,
"quality": "regular",
"overbooking": 0,
"max_download": 102400,
"actions": {}
}
},
"connectionpoint": {
"0/B/MTK/METERKAST": {
"available_service": [],
"available_technology": [
"ADSL",
"VDSL",
"BVDSL"
],
"nl1lines_available": 0,
"nl1lines": 0,
"BVDSL": [
633
],
"nl2lines": 0,
"ADSL": [
616
],
"VDSL": [
626
]
}
}
}
}
},
"jsonrpc": "2.0",
"id": 1
}
Broadband-basic
https://api.nextpertise.nl/broadband/basic/v1
JSON-RPC
zipcode()
Since v1.0.0
Requests an overview of the products available on a specific location.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| filter | object | |
| provider | array | Provider filter |
| provider[#] | enum | Enum options:TELE2|KPNWEAS|KPNWBA|EUROFIBER|ZIGGO. undefined |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| available | object | Provides per access technology the maximum speed (kb/s) and an optional area code. |
| KPNWBA|KPNWEAS|TELE2|EUROFIBER|ZIGGO | object | |
| ADSL|VDSL|BVDSL|SDSL|SDSL.bis|Fiber|VPLUS|BVPLUS | object | |
| max_download | integer | The maximum available download speed in kb/s. |
| max_upload | integer | The maximum available upload speed in kb/s. |
| area | string | A (possibly empty) string indicating recurring costs. |
| distance | string | A (possible empty) string indicating setup costs. |
| carrier | enum | Enum options:Copper|Copper_shared|Copper_only|BCopper_only|Fiber|FttH|FttO|Radio. 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. |
| address | any of, object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null | |
| address | any of, object | |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| error | object | |
| KPNWBA|KPNWEAS|TELE2|EUROFIBER|ZIGGO | object | |
| message | string | |
| code | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "zipcode",
"params": {
"zipcode": "2408ZE",
"housenr": 2,
"housenrext": null,
"filter": {
"provider": [
"TELE2"
]
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"address": {
"street": "Zuidpoolsingel",
"housenr": 2,
"longitude": "4.6538731",
"latitude": "52.1265701",
"province": "Zuid-Holland",
"city": "Alphen aan den Rijn",
"municipality": "Alphen aan den Rijn",
"zipcode": "2408ZE",
"housenrext": null
},
"available": {
"TELE2": {
"Fiber": {
"distance": "Nearnet",
"max_download": 1024000,
"max_upload": 1024000,
"area": "4",
"carrier": "Fiber"
},
"SDSL.bis": {
"distance": "",
"max_download": 6144,
"max_upload": 6144,
"area": "",
"carrier": "Copper"
}
}
}
}
}
Broadband-release
https://api.nextpertise.nl/broadband/release
JSON-RPC
zipcode()
Since v1.0.0
Data needed to request a zipcode
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string | House number suffix. |
| filter | object | |
| provider | array | |
| provider[#] | enum | Enum options:TELE2|KPNWEAS|KPNWBA|EUROFIBER|ZIGGO|WAUWAU|NDIX. An enumeration. |
| connectionpoint | string | The ISRA-specs to retrieve specifically. This is used when the connectionpoints all list incomplete. You should only input the ISRA-specs not the full name, so it should look like '001' |
| timeout | number | The amount of time we wait for the total request to take. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| available | object | Maps providers to availabities |
| KPNWBA | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| KPNWEAS | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| TELE2 | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| EUROFIBER | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| ZIGGO | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| NDIX | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| WAUWAU | object | |
| EVC | object | |
| carrier | object | |
| sla | object | |
| cpe | object | |
| connectionpoint | object | Also known as ISRA point |
| address | object | |
| housenr | integer | |
| housenrext | string | |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| street | string | |
| city | string | |
| province | string | |
| municipality | string | |
| latitude | string | |
| longitude | string | |
| error | object |
Examples
Request example
{
"zipcode": "2408ZE",
"housenr": 10,
"housenrext": null,
"filter": {
"provider": [
"TELE2"
],
"connectionpoint": null,
"timeout": 15
}
}
Reply example
{
"available": {
"TELE2": {
"EVC": {
"680": {
"product_id": 680,
"is_pvc": true,
"name": "Regular circuit 1Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024,
"min_download": 0,
"max_download": 1024
},
"682": {
"product_id": 682,
"is_pvc": true,
"name": "Premium circuit 1Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024,
"min_download": 0,
"max_download": 1024
},
"684": {
"product_id": 684,
"is_pvc": true,
"name": "Regular circuit 2Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 2048,
"min_download": 0,
"max_download": 2048
},
"686": {
"product_id": 686,
"is_pvc": true,
"name": "Premium circuit 2Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 2048,
"min_download": 0,
"max_download": 2048
},
"688": {
"product_id": 688,
"is_pvc": true,
"name": "Regular circuit 4Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 4096,
"download": 4096,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 4096,
"min_download": 0,
"max_download": 4096
},
"690": {
"product_id": 690,
"is_pvc": true,
"name": "Premium circuit 4Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 4096,
"download": 4096,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 4096,
"min_download": 0,
"max_download": 4096
},
"692": {
"product_id": 692,
"is_pvc": true,
"name": "Regular circuit 6Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 6144,
"download": 6144,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 6144,
"min_download": 0,
"max_download": 6144
},
"694": {
"product_id": 694,
"is_pvc": true,
"name": "Premium circuit 6Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 6144,
"download": 6144,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 6144,
"min_download": 0,
"max_download": 6144
},
"696": {
"product_id": 696,
"is_pvc": true,
"name": "Regular circuit 8Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 8192,
"download": 8192,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 8192,
"min_download": 0,
"max_download": 8192
},
"698": {
"product_id": 698,
"is_pvc": true,
"name": "Premium circuit 8Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 8192,
"download": 8192,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 8192,
"min_download": 0,
"max_download": 8192
},
"700": {
"product_id": 700,
"is_pvc": true,
"name": "Regular circuit 10Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 10240,
"min_download": 0,
"max_download": 10240
},
"704": {
"product_id": 704,
"is_pvc": true,
"name": "Regular circuit 15Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 15360,
"download": 15360,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 15360,
"min_download": 0,
"max_download": 15360
},
"706": {
"product_id": 706,
"is_pvc": true,
"name": "Premium circuit 15Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 15360,
"download": 15360,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 15360,
"min_download": 0,
"max_download": 15360
},
"708": {
"product_id": 708,
"is_pvc": true,
"name": "Regular circuit 20Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 20480,
"min_download": 0,
"max_download": 20480
},
"710": {
"product_id": 710,
"is_pvc": true,
"name": "Premium circuit 20Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 20480,
"min_download": 0,
"max_download": 20480
},
"724": {
"product_id": 724,
"is_pvc": true,
"name": "Premium circuit 10Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 10240,
"min_download": 0,
"max_download": 10240
},
"730": {
"product_id": 730,
"is_pvc": true,
"name": "Regular circuit 50Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 51200,
"min_download": 0,
"max_download": 51200
},
"732": {
"product_id": 732,
"is_pvc": true,
"name": "Premium circuit 50Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 51200,
"min_download": 0,
"max_download": 51200
},
"734": {
"product_id": 734,
"is_pvc": true,
"name": "Regular circuit 100Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 102400,
"min_download": 0,
"max_download": 102400
},
"736": {
"product_id": 736,
"is_pvc": true,
"name": "Premium circuit 100Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 102400,
"min_download": 0,
"max_download": 102400
},
"738": {
"product_id": 738,
"is_pvc": true,
"name": "Regular circuit 200Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 204800,
"min_download": 0,
"max_download": 204800
},
"740": {
"product_id": 740,
"is_pvc": true,
"name": "Premium circuit 200Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 204800,
"min_download": 0,
"max_download": 204800
},
"742": {
"product_id": 742,
"is_pvc": true,
"name": "Regular circuit 500Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 512000,
"min_download": 0,
"max_download": 512000
},
"744": {
"product_id": 744,
"is_pvc": true,
"name": "Premium circuit 500Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 512000,
"min_download": 0,
"max_download": 512000
},
"746": {
"product_id": 746,
"is_pvc": true,
"name": "Regular circuit 1000Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024000,
"min_download": 0,
"max_download": 1024000
},
"748": {
"product_id": 748,
"is_pvc": true,
"name": "Premium circuit 1000Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024000,
"min_download": 0,
"max_download": 1024000
}
},
"carrier": {
"677": {
"product_id": 677,
"name": "Fiber (4-Onnet)",
"description": null,
"extrainfo": null,
"distance": "4-Onnet",
"area": "",
"carrier_type": "Fiber",
"download": 10485760,
"upload": 10485760,
"terminate_voice": null,
"data_technology": "Fiber",
"sub_technology": null,
"wishdate": false,
"estimated_delivery_duration": null,
"contract_duration": [
12,
36,
60
],
"circuits": [
680,
682,
684,
686,
688,
690,
692,
694,
696,
698,
700,
704,
706,
708,
710,
724,
730,
732,
734,
736,
738,
740,
742,
744,
746,
748
],
"sla": [
752
],
"cpe": []
}
},
"sla": {
"752": {
"product_id": 752,
"supplier": "TELE2",
"name": "Gold SLA",
"description": "TELE2 Gold"
}
},
"cpe": {},
"connectionpoint": {
"001///": {
"Fiber": [
677
],
"available_technology": [
"Fiber"
]
}
}
}
},
"address": {
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"city": "Alphen aan den Rijn",
"zipcode": "2408ZE",
"street": "Zuidpoolsingel",
"housenr": 10,
"housenrext": "",
"latitude": "52.1266051",
"longitude": "4.6533684"
},
"error": {}
}
Request example
{
"zipcode": "2408ZE",
"housenr": 10,
"housenrext": null,
"filter": {
"provider": [],
"connectionpoint": null,
"timeout": 30
}
}
Reply example
{
"available": {
"WAUWAU": {
"EVC": {},
"carrier": {},
"sla": {},
"cpe": {},
"connectionpoint": {}
},
"EUROFIBER": {
"EVC": {
"448": {
"product_id": 448,
"is_pvc": true,
"name": "Regular circuit 10Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 10240,
"max_upload": 10240,
"min_download": 0,
"min_upload": 0
},
"449": {
"product_id": 449,
"is_pvc": true,
"name": "Regular circuit 20Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 20480,
"max_upload": 20480,
"min_download": 0,
"min_upload": 0
},
"450": {
"product_id": 450,
"is_pvc": true,
"name": "Regular circuit 50Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 51200,
"max_upload": 51200,
"min_download": 0,
"min_upload": 0
},
"451": {
"product_id": 451,
"is_pvc": true,
"name": "Regular circuit 100Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 102400,
"max_upload": 102400,
"min_download": 0,
"min_upload": 0
},
"452": {
"product_id": 452,
"is_pvc": true,
"name": "Regular circuit 200Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 204800,
"max_upload": 204800,
"min_download": 0,
"min_upload": 0
},
"453": {
"product_id": 453,
"is_pvc": true,
"name": "Regular circuit 500Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 512000,
"max_upload": 512000,
"min_download": 0,
"min_upload": 0
},
"454": {
"product_id": 454,
"is_pvc": true,
"name": "Premium circuit 10Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 10240,
"max_upload": 10240,
"min_download": 0,
"min_upload": 0
},
"455": {
"product_id": 455,
"is_pvc": true,
"name": "Premium circuit 20Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 20480,
"max_upload": 20480,
"min_download": 0,
"min_upload": 0
},
"456": {
"product_id": 456,
"is_pvc": true,
"name": "Premium circuit 50Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 51200,
"max_upload": 51200,
"min_download": 0,
"min_upload": 0
},
"457": {
"product_id": 457,
"is_pvc": true,
"name": "Premium circuit 100Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 102400,
"max_upload": 102400,
"min_download": 0,
"min_upload": 0
},
"458": {
"product_id": 458,
"is_pvc": true,
"name": "Premium circuit 200Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 204800,
"max_upload": 204800,
"min_download": 0,
"min_upload": 0
},
"459": {
"product_id": 459,
"is_pvc": true,
"name": "Premium circuit 500Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 512000,
"max_upload": 512000,
"min_download": 0,
"min_upload": 0
},
"460": {
"product_id": 460,
"is_pvc": false,
"name": "Regular circuit 5Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 5120,
"download": 5120,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 5120,
"max_upload": 5120,
"min_download": 0,
"min_upload": 0
},
"461": {
"product_id": 461,
"is_pvc": false,
"name": "Premium circuit 5Mb",
"supplier": "EUROFIBER",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 5120,
"download": 5120,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 5120,
"max_upload": 5120,
"min_download": 0,
"min_upload": 0
}
},
"carrier": {
"447": {
"product_id": 447,
"name": "Fiber",
"description": null,
"extrainfo": null,
"distance": "B",
"area": "",
"carrier_type": "Fiber",
"download": 1024000,
"upload": 1024000,
"terminate_voice": null,
"data_technology": "Fiber",
"sub_technology": null,
"wishdate": false,
"estimated_delivery_duration": null,
"contract_duration": [
12,
24,
36
],
"circuits": [
448,
449,
450,
451,
452,
453,
454,
455,
456,
457,
458,
459,
460,
461
],
"sla": [
757
],
"cpe": []
}
},
"sla": {
"757": {
"product_id": 757,
"supplier": "EUROFIBER",
"name": "Standard SLA",
"description": "EUROFIBER Standard"
}
},
"cpe": {},
"connectionpoint": {
"noname": {
"Fiber": [
447
],
"available_technology": [
"Fiber"
]
}
}
},
"KPNWBA": {
"EVC": {
"253": {
"product_id": 253,
"is_pvc": true,
"name": "KPN PREMIUM 2048",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": 6530,
"active": true,
"max_download": 2048,
"min_download": 0,
"max_upload": 2048,
"min_upload": 0
},
"255": {
"product_id": 255,
"is_pvc": true,
"name": "KPN PREMIUM 5120",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 5120,
"download": 5120,
"overbooking": 0,
"service_type": 6564,
"active": true,
"max_download": 5120,
"min_download": 0,
"max_upload": 5120,
"min_upload": 0
},
"277": {
"product_id": 277,
"is_pvc": true,
"name": "KPN REGULAR 51200",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": 7352,
"active": true,
"max_download": 51200,
"min_download": 0,
"max_upload": 51200,
"min_upload": 0
},
"279": {
"product_id": 279,
"is_pvc": true,
"name": "KPN REGULAR 100000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 100000,
"download": 100000,
"overbooking": 0,
"service_type": 7396,
"active": true,
"max_download": 102400,
"min_download": 0,
"max_upload": 102400,
"min_upload": 0
},
"280": {
"product_id": 280,
"is_pvc": true,
"name": "KPN REGULAR 200000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 200000,
"download": 200000,
"overbooking": 0,
"service_type": 7420,
"active": true,
"max_download": 204800,
"min_download": 0,
"max_upload": 204800,
"min_upload": 0
},
"281": {
"product_id": 281,
"is_pvc": true,
"name": "KPN REGULAR 524000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 524000,
"download": 524000,
"overbooking": 0,
"service_type": 7450,
"active": true,
"max_download": 512000,
"min_download": 0,
"max_upload": 512000,
"min_upload": 0
},
"775": {
"product_id": 775,
"is_pvc": true,
"name": "KPN PREMIUM 1024",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": 6512,
"active": true,
"max_download": 1024,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"779": {
"product_id": 779,
"is_pvc": true,
"name": "KPN PREMIUM 10240",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": 6612,
"active": true,
"max_download": 10240,
"min_download": 0,
"max_upload": 10240,
"min_upload": 0
},
"780": {
"product_id": 780,
"is_pvc": true,
"name": "KPN PREMIUM 20000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 20000,
"download": 20000,
"overbooking": 0,
"service_type": 6622,
"active": true,
"max_download": 20480,
"min_download": 0,
"max_upload": 20480,
"min_upload": 0
},
"782": {
"product_id": 782,
"is_pvc": true,
"name": "KPN PREMIUM 256",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 256,
"download": 256,
"overbooking": 0,
"service_type": 6506,
"active": true,
"max_download": 256,
"min_download": 0,
"max_upload": 256,
"min_upload": 0
}
},
"carrier": {
"636": {
"product_id": 636,
"name": "GoF (non-shared line, FMIGRATE, ZTL)",
"description": null,
"extrainfo": null,
"distance": "MIGRATE",
"area": "FttH",
"carrier_type": "Fiber",
"download": 524000,
"upload": 524000,
"terminate_voice": false,
"data_technology": "Fiber",
"sub_technology": "GoF",
"wishdate": true,
"estimated_delivery_duration": "10d",
"contract_duration": [
12
],
"circuits": [
253,
255,
775,
779,
780,
782,
277,
279,
280,
281
],
"sla": [
758,
759
],
"cpe": []
}
},
"sla": {
"758": {
"product_id": 758,
"supplier": "KPNWBA",
"name": "Best Effort",
"description": "KPNWBA Best Effort - Standard (FTT[H/O])"
},
"759": {
"product_id": 759,
"supplier": "KPNWBA",
"name": "24x7",
"description": "KPNWBA 24x7 - Premium (FTT[H/O])"
}
},
"cpe": {
"651": {
"product_id": 651,
"name": "Wall outlet",
"description": null,
"extrainfo": null
}
},
"connectionpoint": {
"0": {
"Fiber": [
636
],
"available_technology": [
"Fiber"
],
"ftu_type": "FTU_GN02",
"orderable": true,
"available_service": [
{
"service": "REF0002736675",
"type": 5
}
]
}
}
},
"KPNWEAS": {
"EVC": {
"526": {
"product_id": 526,
"is_pvc": true,
"name": "Regular National circuit 1Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 1024,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"527": {
"product_id": 527,
"is_pvc": true,
"name": "Regular National circuit 2Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 2048,
"min_download": 0,
"max_upload": 2048,
"min_upload": 0
},
"528": {
"product_id": 528,
"is_pvc": true,
"name": "Regular National circuit 3Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 3072,
"download": 3072,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 3072,
"min_download": 0,
"max_upload": 3072,
"min_upload": 0
},
"529": {
"product_id": 529,
"is_pvc": true,
"name": "Regular National circuit 4Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 4096,
"download": 4096,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 4096,
"min_download": 0,
"max_upload": 4096,
"min_upload": 0
},
"530": {
"product_id": 530,
"is_pvc": true,
"name": "Regular National circuit 5Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 5120,
"download": 5120,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 5120,
"min_download": 0,
"max_upload": 5120,
"min_upload": 0
},
"531": {
"product_id": 531,
"is_pvc": true,
"name": "Regular National circuit 6Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 6144,
"download": 6144,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 6144,
"min_download": 0,
"max_upload": 6144,
"min_upload": 0
},
"532": {
"product_id": 532,
"is_pvc": true,
"name": "Regular National circuit 8Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 8192,
"download": 8192,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 8192,
"min_download": 0,
"max_upload": 8192,
"min_upload": 0
},
"533": {
"product_id": 533,
"is_pvc": true,
"name": "Regular National circuit 10Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 10240,
"min_download": 0,
"max_upload": 10240,
"min_upload": 0
},
"534": {
"product_id": 534,
"is_pvc": true,
"name": "Regular National circuit 15Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 15360,
"download": 15360,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 16384,
"min_download": 0,
"max_upload": 16384,
"min_upload": 0
},
"535": {
"product_id": 535,
"is_pvc": true,
"name": "Regular National circuit 20Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 20480,
"min_download": 0,
"max_upload": 20480,
"min_upload": 0
},
"536": {
"product_id": 536,
"is_pvc": true,
"name": "Regular National circuit 30Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 30720,
"download": 30720,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 30720,
"min_download": 0,
"max_upload": 30720,
"min_upload": 0
},
"537": {
"product_id": 537,
"is_pvc": true,
"name": "Regular National circuit 50Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 51200,
"min_download": 0,
"max_upload": 51200,
"min_upload": 0
},
"538": {
"product_id": 538,
"is_pvc": true,
"name": "Regular National circuit 80Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 81920,
"download": 81920,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 81920,
"min_download": 0,
"max_upload": 81920,
"min_upload": 0
},
"539": {
"product_id": 539,
"is_pvc": true,
"name": "Regular National circuit 100Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 102400,
"min_download": 0,
"max_upload": 102400,
"min_upload": 0
},
"540": {
"product_id": 540,
"is_pvc": true,
"name": "Regular National circuit 200Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 204800,
"min_download": 0,
"max_upload": 204800,
"min_upload": 0
},
"541": {
"product_id": 541,
"is_pvc": true,
"name": "Regular National circuit 300Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 307200,
"download": 307200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 307200,
"min_download": 0,
"max_upload": 307200,
"min_upload": 0
},
"542": {
"product_id": 542,
"is_pvc": true,
"name": "Regular National circuit 500Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 512000,
"min_download": 0,
"max_upload": 512000,
"min_upload": 0
},
"543": {
"product_id": 543,
"is_pvc": true,
"name": "Regular National circuit 800Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 819200,
"download": 819200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 819200,
"min_download": 0,
"max_upload": 819200,
"min_upload": 0
},
"580": {
"product_id": 580,
"is_pvc": true,
"name": "Premium National circuit 1Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 1024,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"581": {
"product_id": 581,
"is_pvc": true,
"name": "Premium National circuit 2Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 2048,
"min_download": 0,
"max_upload": 2048,
"min_upload": 0
},
"582": {
"product_id": 582,
"is_pvc": true,
"name": "Premium National circuit 3Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 3072,
"download": 3072,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 3072,
"min_download": 0,
"max_upload": 3072,
"min_upload": 0
},
"583": {
"product_id": 583,
"is_pvc": true,
"name": "Premium National circuit 4Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 4096,
"download": 4096,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 4096,
"min_download": 0,
"max_upload": 4096,
"min_upload": 0
},
"584": {
"product_id": 584,
"is_pvc": true,
"name": "Premium National circuit 5Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 5120,
"download": 5120,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 5120,
"min_download": 0,
"max_upload": 5120,
"min_upload": 0
},
"585": {
"product_id": 585,
"is_pvc": true,
"name": "Premium National circuit 6Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 6144,
"download": 6144,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 6144,
"min_download": 0,
"max_upload": 6144,
"min_upload": 0
},
"586": {
"product_id": 586,
"is_pvc": true,
"name": "Premium National circuit 8Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 8192,
"download": 8192,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 8192,
"min_download": 0,
"max_upload": 8192,
"min_upload": 0
},
"587": {
"product_id": 587,
"is_pvc": true,
"name": "Premium National circuit 10Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 10240,
"min_download": 0,
"max_upload": 10240,
"min_upload": 0
},
"588": {
"product_id": 588,
"is_pvc": true,
"name": "Premium National circuit 15Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 15360,
"download": 15360,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 16384,
"min_download": 0,
"max_upload": 16384,
"min_upload": 0
},
"589": {
"product_id": 589,
"is_pvc": true,
"name": "Premium National circuit 20Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 20480,
"min_download": 0,
"max_upload": 20480,
"min_upload": 0
},
"590": {
"product_id": 590,
"is_pvc": true,
"name": "Premium National circuit 30Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 30720,
"download": 30720,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 30720,
"min_download": 0,
"max_upload": 30720,
"min_upload": 0
},
"591": {
"product_id": 591,
"is_pvc": true,
"name": "Premium National circuit 50Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 51200,
"min_download": 0,
"max_upload": 51200,
"min_upload": 0
},
"592": {
"product_id": 592,
"is_pvc": true,
"name": "Premium National circuit 80Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 81920,
"download": 81920,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 81920,
"min_download": 0,
"max_upload": 81920,
"min_upload": 0
},
"593": {
"product_id": 593,
"is_pvc": true,
"name": "Premium National circuit 100Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 102400,
"min_download": 0,
"max_upload": 102400,
"min_upload": 0
},
"594": {
"product_id": 594,
"is_pvc": true,
"name": "Premium National circuit 200Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 204800,
"min_download": 0,
"max_upload": 204800,
"min_upload": 0
},
"595": {
"product_id": 595,
"is_pvc": true,
"name": "Premium National circuit 300Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 307200,
"download": 307200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 307200,
"min_download": 0,
"max_upload": 307200,
"min_upload": 0
},
"596": {
"product_id": 596,
"is_pvc": true,
"name": "Premium National circuit 500Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 512000,
"min_download": 0,
"max_upload": 512000,
"min_upload": 0
},
"597": {
"product_id": 597,
"is_pvc": true,
"name": "Premium National circuit 800Mb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 819200,
"download": 819200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 819200,
"min_download": 0,
"max_upload": 819200,
"min_upload": 0
},
"647": {
"product_id": 647,
"is_pvc": true,
"name": "Regular National circuit 1Gb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 1024000,
"min_download": 0,
"max_upload": 1024000,
"min_upload": 0
},
"650": {
"product_id": 650,
"is_pvc": true,
"name": "Premium National circuit 1Gb",
"supplier": "KPNWEAS",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 1024000,
"min_download": 0,
"max_upload": 1024000,
"min_upload": 0
}
},
"carrier": {
"475": {
"product_id": 475,
"name": "Fiber (B/Nearnet)",
"description": null,
"extrainfo": null,
"distance": "NEARNET",
"area": "B",
"carrier_type": "Fiber",
"download": 1024000,
"upload": 1024000,
"terminate_voice": null,
"data_technology": "Fiber",
"sub_technology": null,
"wishdate": false,
"estimated_delivery_duration": null,
"contract_duration": [
12,
24,
36
],
"circuits": [
526,
527,
528,
529,
530,
531,
532,
533,
534,
535,
536,
537,
538,
539,
540,
541,
542,
543,
580,
581,
582,
583,
584,
585,
586,
587,
588,
589,
590,
591,
592,
593,
594,
595,
596,
597,
647,
650
],
"sla": [
749,
750
],
"cpe": []
}
},
"sla": {
"749": {
"product_id": 749,
"supplier": "KPNWEAS",
"name": "Standard SLA",
"description": "WEAS Standard"
},
"750": {
"product_id": 750,
"supplier": "KPNWEAS",
"name": "Advanced SLA",
"description": "WEAS Advanced"
}
},
"cpe": {},
"connectionpoint": {
"noname": {
"Fiber": [
475
],
"available_technology": [
"Fiber"
]
}
}
},
"NDIX": {
"EVC": {},
"carrier": {},
"sla": {},
"cpe": {},
"connectionpoint": {}
},
"TELE2": {
"EVC": {
"680": {
"product_id": 680,
"is_pvc": true,
"name": "Regular circuit 1Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024,
"min_download": 0,
"max_download": 1024
},
"682": {
"product_id": 682,
"is_pvc": true,
"name": "Premium circuit 1Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024,
"min_download": 0,
"max_download": 1024
},
"684": {
"product_id": 684,
"is_pvc": true,
"name": "Regular circuit 2Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 2048,
"min_download": 0,
"max_download": 2048
},
"686": {
"product_id": 686,
"is_pvc": true,
"name": "Premium circuit 2Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 2048,
"min_download": 0,
"max_download": 2048
},
"688": {
"product_id": 688,
"is_pvc": true,
"name": "Regular circuit 4Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 4096,
"download": 4096,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 4096,
"min_download": 0,
"max_download": 4096
},
"690": {
"product_id": 690,
"is_pvc": true,
"name": "Premium circuit 4Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 4096,
"download": 4096,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 4096,
"min_download": 0,
"max_download": 4096
},
"692": {
"product_id": 692,
"is_pvc": true,
"name": "Regular circuit 6Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 6144,
"download": 6144,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 6144,
"min_download": 0,
"max_download": 6144
},
"694": {
"product_id": 694,
"is_pvc": true,
"name": "Premium circuit 6Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 6144,
"download": 6144,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 6144,
"min_download": 0,
"max_download": 6144
},
"696": {
"product_id": 696,
"is_pvc": true,
"name": "Regular circuit 8Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 8192,
"download": 8192,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 8192,
"min_download": 0,
"max_download": 8192
},
"698": {
"product_id": 698,
"is_pvc": true,
"name": "Premium circuit 8Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 8192,
"download": 8192,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 8192,
"min_download": 0,
"max_download": 8192
},
"700": {
"product_id": 700,
"is_pvc": true,
"name": "Regular circuit 10Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 10240,
"min_download": 0,
"max_download": 10240
},
"704": {
"product_id": 704,
"is_pvc": true,
"name": "Regular circuit 15Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 15360,
"download": 15360,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 15360,
"min_download": 0,
"max_download": 15360
},
"706": {
"product_id": 706,
"is_pvc": true,
"name": "Premium circuit 15Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 15360,
"download": 15360,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 15360,
"min_download": 0,
"max_download": 15360
},
"708": {
"product_id": 708,
"is_pvc": true,
"name": "Regular circuit 20Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 20480,
"min_download": 0,
"max_download": 20480
},
"710": {
"product_id": 710,
"is_pvc": true,
"name": "Premium circuit 20Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 20480,
"download": 20480,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 20480,
"min_download": 0,
"max_download": 20480
},
"724": {
"product_id": 724,
"is_pvc": true,
"name": "Premium circuit 10Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 10240,
"min_download": 0,
"max_download": 10240
},
"730": {
"product_id": 730,
"is_pvc": true,
"name": "Regular circuit 50Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 51200,
"min_download": 0,
"max_download": 51200
},
"732": {
"product_id": 732,
"is_pvc": true,
"name": "Premium circuit 50Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 51200,
"min_download": 0,
"max_download": 51200
},
"734": {
"product_id": 734,
"is_pvc": true,
"name": "Regular circuit 100Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 102400,
"min_download": 0,
"max_download": 102400
},
"736": {
"product_id": 736,
"is_pvc": true,
"name": "Premium circuit 100Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 102400,
"min_download": 0,
"max_download": 102400
},
"738": {
"product_id": 738,
"is_pvc": true,
"name": "Regular circuit 200Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 204800,
"min_download": 0,
"max_download": 204800
},
"740": {
"product_id": 740,
"is_pvc": true,
"name": "Premium circuit 200Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 204800,
"min_download": 0,
"max_download": 204800
},
"742": {
"product_id": 742,
"is_pvc": true,
"name": "Regular circuit 500Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 512000,
"min_download": 0,
"max_download": 512000
},
"744": {
"product_id": 744,
"is_pvc": true,
"name": "Premium circuit 500Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 512000,
"min_download": 0,
"max_download": 512000
},
"746": {
"product_id": 746,
"is_pvc": true,
"name": "Regular circuit 1000Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": "NATIONAL",
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024000,
"min_download": 0,
"max_download": 1024000
},
"748": {
"product_id": 748,
"is_pvc": true,
"name": "Premium circuit 1000Mb",
"supplier": "TELE2",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": "NATIONAL",
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"min_upload": 0,
"max_upload": 1024000,
"min_download": 0,
"max_download": 1024000
}
},
"carrier": {
"677": {
"product_id": 677,
"name": "Fiber (4-Onnet)",
"description": null,
"extrainfo": null,
"distance": "4-Onnet",
"area": "",
"carrier_type": "Fiber",
"download": 10485760,
"upload": 10485760,
"terminate_voice": null,
"data_technology": "Fiber",
"sub_technology": null,
"wishdate": false,
"estimated_delivery_duration": null,
"contract_duration": [
12,
36,
60
],
"circuits": [
680,
682,
684,
686,
688,
690,
692,
694,
696,
698,
700,
704,
706,
708,
710,
724,
730,
732,
734,
736,
738,
740,
742,
744,
746,
748
],
"sla": [
752
],
"cpe": []
}
},
"sla": {
"752": {
"product_id": 752,
"supplier": "TELE2",
"name": "Gold SLA",
"description": "TELE2 Gold"
}
},
"cpe": {},
"connectionpoint": {
"001///": {
"Fiber": [
677
],
"available_technology": [
"Fiber"
]
}
}
},
"ZIGGO": {
"EVC": {
"762": {
"product_id": 762,
"is_pvc": true,
"name": "50 Mb/s LITE",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 51200,
"download": 51200,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 51200,
"min_download": 51200,
"max_upload": 51200,
"min_upload": 51200
},
"763": {
"product_id": 763,
"is_pvc": true,
"name": "100 Mb/s LITE",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 102400,
"download": 102400,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 102400,
"min_download": 102400,
"max_upload": 102400,
"min_upload": 102400
},
"764": {
"product_id": 764,
"is_pvc": true,
"name": "200 Mb/s LITE",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 204800,
"download": 204800,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 204800,
"min_download": 204800,
"max_upload": 204800,
"min_upload": 204800
},
"765": {
"product_id": 765,
"is_pvc": true,
"name": "500 Mb/s LITE",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 512000,
"download": 512000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 512000,
"min_download": 512000,
"max_upload": 512000,
"min_upload": 512000
},
"766": {
"product_id": 766,
"is_pvc": true,
"name": "1 Gb/s LITE",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "regular",
"area": null,
"upload": 1024000,
"download": 1024000,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 1024000,
"min_download": 1024000,
"max_upload": 1024000,
"min_upload": 1024000
},
"767": {
"product_id": 767,
"is_pvc": false,
"name": "2 Mb/s PREMIUM",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 2048,
"min_download": 2048,
"max_upload": 2048,
"min_upload": 2048
},
"768": {
"product_id": 768,
"is_pvc": false,
"name": "5 Mb/s PREMIUM",
"supplier": "ZIGGO",
"transport_instance": null,
"qos": null,
"quality": "premium",
"area": null,
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": null,
"active": true,
"max_download": 1024,
"min_download": 1024,
"max_upload": 1024,
"min_upload": 1024
}
},
"carrier": {
"761": {
"product_id": 761,
"name": "Fiber",
"description": null,
"extrainfo": null,
"distance": "Nearnet;105m",
"area": "",
"carrier_type": "Fiber",
"download": 1024000,
"upload": 1024000,
"terminate_voice": false,
"data_technology": "Fiber",
"sub_technology": null,
"wishdate": false,
"estimated_delivery_duration": null,
"contract_duration": [
12,
24,
36
],
"circuits": [
762,
763,
764,
765,
766,
767,
768
],
"sla": [
760
],
"cpe": []
}
},
"sla": {
"760": {
"product_id": 760,
"supplier": "ZIGGO",
"name": "Standard SLA",
"description": "ZIGGO Standard"
}
},
"cpe": {},
"connectionpoint": {
"noname": {
"Fiber": [
761
],
"available_technology": [
"Fiber"
]
}
}
}
},
"address": {
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"city": "Alphen aan den Rijn",
"zipcode": "2408ZE",
"street": "Zuidpoolsingel",
"housenr": 10,
"housenrext": "",
"latitude": "52.1266051",
"longitude": "4.6533684"
},
"error": {}
}
Request example
{
"zipcode": "2231BZ",
"housenr": 3,
"housenrext": null,
"filter": {
"provider": [
"KPNWBA"
],
"connectionpoint": "001",
"timeout": 30
}
}
Reply example
{
"available": {
"KPNWBA": {
"EVC": {
"249": {
"product_id": 249,
"is_pvc": true,
"name": "KPN PREMIUM 1024",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": 8640,
"active": true,
"max_download": 1024,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"257": {
"product_id": 257,
"is_pvc": true,
"name": "KPN PREMIUM 10240",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 10240,
"download": 10240,
"overbooking": 0,
"service_type": 8710,
"active": true,
"max_download": 10240,
"min_download": 0,
"max_upload": 10240,
"min_upload": 0
},
"258": {
"product_id": 258,
"is_pvc": true,
"name": "KPN PREMIUM 20000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 20000,
"download": 20000,
"overbooking": 0,
"service_type": 8712,
"active": true,
"max_download": 20480,
"min_download": 0,
"max_upload": 20480,
"min_upload": 0
},
"267": {
"product_id": 267,
"is_pvc": true,
"name": "KPN REGULAR 20480",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 2048,
"download": 20480,
"overbooking": 0,
"service_type": 8374,
"active": true,
"max_download": 20480,
"min_download": 0,
"max_upload": 2048,
"min_upload": 0
},
"268": {
"product_id": 268,
"is_pvc": true,
"name": "KPN REGULAR 30720",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 3072,
"download": 30720,
"overbooking": 0,
"service_type": 8386,
"active": true,
"max_download": 30720,
"min_download": 0,
"max_upload": 3072,
"min_upload": 0
},
"272": {
"product_id": 272,
"is_pvc": true,
"name": "KPN REGULAR 51200",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "Best Effort",
"quality": "regular",
"area": null,
"upload": 10240,
"download": 51200,
"overbooking": 0,
"service_type": 8405,
"active": true,
"max_download": 51200,
"min_download": 0,
"max_upload": 10240,
"min_upload": 0
},
"299": {
"product_id": 299,
"is_pvc": true,
"name": "KPN PREMIUM 256",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "VBRrt",
"quality": "premium",
"area": null,
"upload": 256,
"download": 256,
"overbooking": 0,
"service_type": 8208,
"active": true,
"max_download": 256,
"min_download": 0,
"max_upload": 256,
"min_upload": 0
},
"300": {
"product_id": 300,
"is_pvc": true,
"name": "KPN PREMIUM 2048",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "VBRrt",
"quality": "premium",
"area": null,
"upload": 1024,
"download": 2048,
"overbooking": 0,
"service_type": 8212,
"active": true,
"max_download": 2048,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"301": {
"product_id": 301,
"is_pvc": true,
"name": "KPN PREMIUM 5120",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "VBRrt",
"quality": "premium",
"area": null,
"upload": 1024,
"download": 5120,
"overbooking": 0,
"service_type": 8214,
"active": true,
"max_download": 5120,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"311": {
"product_id": 311,
"is_pvc": true,
"name": "KPN REGULAR 20000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/1",
"qos": "GFR",
"quality": "regular",
"area": null,
"upload": 1024,
"download": 20000,
"overbooking": 0,
"service_type": 8265,
"active": true,
"max_download": 20480,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"316": {
"product_id": 316,
"is_pvc": true,
"name": "KPN PREMIUM 50000",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 10240,
"download": 50000,
"overbooking": 0,
"service_type": 8713,
"active": true,
"max_download": 51200,
"min_download": 0,
"max_upload": 10240,
"min_upload": 0
},
"332": {
"product_id": 332,
"is_pvc": true,
"name": "KPN PREMIUM 256",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 256,
"download": 256,
"overbooking": 0,
"service_type": 8608,
"active": true,
"max_download": 256,
"min_download": 0,
"max_upload": 256,
"min_upload": 0
},
"776": {
"product_id": 776,
"is_pvc": true,
"name": "KPN PREMIUM 1024",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "VBRrt",
"quality": "premium",
"area": null,
"upload": 1024,
"download": 1024,
"overbooking": 0,
"service_type": 8210,
"active": true,
"max_download": 1024,
"min_download": 0,
"max_upload": 1024,
"min_upload": 0
},
"777": {
"product_id": 777,
"is_pvc": true,
"name": "KPN PREMIUM 2048",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 2048,
"download": 2048,
"overbooking": 0,
"service_type": 8662,
"active": true,
"max_download": 2048,
"min_download": 0,
"max_upload": 2048,
"min_upload": 0
},
"778": {
"product_id": 778,
"is_pvc": true,
"name": "KPN PREMIUM 5120",
"supplier": "KPNWBA",
"transport_instance": "TI-NEXT/2",
"qos": "Premium",
"quality": "premium",
"area": null,
"upload": 5120,
"download": 5120,
"overbooking": 0,
"service_type": 8700,
"active": true,
"max_download": 5120,
"min_download": 0,
"max_upload": 5120,
"min_upload": 0
},
"783": {
"product_id": 783,
"is_pvc": true,
"name": "KPN REGULAR 512",
"supplier": "KPNWBA",
"transport_instance": null,
"qos": "Premium",
"quality": "regular",
"area": null,
"upload": 512,
"download": 512,
"overbooking": 99999,
"service_type": 8615,
"active": true,
"max_download": 512,
"min_download": 0,
"max_upload": 512,
"min_upload": 0
}
},
"carrier": {
"610": {
"product_id": 610,
"name": "ADSL2+ (non-shared line, NLS1, ZTL)",
"description": null,
"extrainfo": null,
"distance": "NLS1;ZTL",
"area": "",
"carrier_type": "Copper_only",
"download": 4531,
"upload": 896,
"terminate_voice": false,
"data_technology": "ADSL",
"sub_technology": "ADSL2+",
"wishdate": true,
"estimated_delivery_duration": "6d",
"contract_duration": [
12
],
"circuits": [
299,
300,
301,
776,
311
],
"sla": [
606,
607,
608
],
"cpe": []
},
"612": {
"product_id": 612,
"name": "ADSL2+ (non-shared line, NLS1, TL)",
"description": null,
"extrainfo": null,
"distance": "NLS1;TL",
"area": "",
"carrier_type": "Copper_only",
"download": 4531,
"upload": 896,
"terminate_voice": false,
"data_technology": "ADSL",
"sub_technology": "ADSL2+",
"wishdate": true,
"estimated_delivery_duration": "10d",
"contract_duration": [
12
],
"circuits": [
299,
300,
301,
776,
311
],
"sla": [
606,
607,
608
],
"cpe": [
651
]
},
"618": {
"product_id": 618,
"name": "ADSL2+ (non-shared line, CMIGRATE, ZTL)",
"description": null,
"extrainfo": null,
"distance": "MIGRATE",
"area": "",
"carrier_type": "Copper_only",
"download": 4531,
"upload": 896,
"terminate_voice": false,
"data_technology": "ADSL",
"sub_technology": "ADSL2+",
"wishdate": true,
"estimated_delivery_duration": "10d",
"contract_duration": [
12
],
"circuits": [
299,
300,
301,
776,
311
],
"sla": [
606,
607,
608
],
"cpe": []
},
"620": {
"product_id": 620,
"name": "VVDSL2 (non-shared line, NLS1, ZTL)",
"description": null,
"extrainfo": null,
"distance": "NLS1;ZTL",
"area": "",
"carrier_type": "Copper_only",
"download": 37965,
"upload": 6141,
"terminate_voice": false,
"data_technology": "VDSL",
"sub_technology": "VVDSL2",
"wishdate": true,
"estimated_delivery_duration": "6d",
"contract_duration": [
12
],
"circuits": [
249,
257,
258,
316,
332,
777,
778,
267,
268,
272,
783
],
"sla": [
606,
607,
608
],
"cpe": []
},
"622": {
"product_id": 622,
"name": "VVDSL2 (non-shared line, NLS1, TL)",
"description": null,
"extrainfo": null,
"distance": "NLS1;TL",
"area": "",
"carrier_type": "Copper_only",
"download": 37965,
"upload": 6141,
"terminate_voice": false,
"data_technology": "VDSL",
"sub_technology": "VVDSL2",
"wishdate": true,
"estimated_delivery_duration": "10d",
"contract_duration": [
12
],
"circuits": [
249,
257,
258,
316,
332,
777,
778,
267,
268,
272,
783
],
"sla": [
606,
607,
608
],
"cpe": [
651
]
},
"628": {
"product_id": 628,
"name": "VVDSL2 (non-shared line, CMIGRATE, ZTL)",
"description": null,
"extrainfo": null,
"distance": "MIGRATE",
"area": "",
"carrier_type": "Copper_only",
"download": 37965,
"upload": 6141,
"terminate_voice": false,
"data_technology": "VDSL",
"sub_technology": "VVDSL2",
"wishdate": true,
"estimated_delivery_duration": "10d",
"contract_duration": [
12
],
"circuits": [
249,
257,
258,
316,
332,
777,
778,
267,
268,
272,
783
],
"sla": [
606,
607,
608
],
"cpe": []
}
},
"sla": {
"606": {
"product_id": 606,
"supplier": "KPNWBA",
"name": "Best Effort",
"description": "KPNWBA Best Effort - Standard (Copper)"
},
"607": {
"product_id": 607,
"supplier": "KPNWBA",
"name": "Office hours",
"description": "KPNWBA Office Hours - Standard+ (Copper)"
},
"608": {
"product_id": 608,
"supplier": "KPNWBA",
"name": "24x7",
"description": "KPNWBA 24x7 - Premium (Copper)"
}
},
"cpe": {
"651": {
"product_id": 651,
"name": "Wall outlet",
"description": null,
"extrainfo": null
}
},
"connectionpoint": {
"001/B/AUT/AUTOMAATRUIMTE": {
"ADSL": [
610,
612,
618
],
"VDSL": [
620,
622,
628
],
"available_technology": [
"ADSL",
"VDSL"
],
"nl1lines": 40,
"nl2lines": 0,
"nl1lines_available": 34,
"isra-specs": "001/B/AUT/AUTOMAATRUIMTE",
"cgb-name": "Kawij-Aw",
"available_service": [
{
"service": "CHL65244",
"orderable": true,
"phonenumber": null,
"type": 3
},
{
"service": "CGX39486",
"orderable": true,
"phonenumber": null,
"type": 3
},
{
"service": "CGN76515",
"orderable": true,
"phonenumber": null,
"type": 3
},
{
"service": "CGP05679",
"orderable": true,
"phonenumber": null,
"type": 3
},
{
"service": "CCL06620",
"orderable": true,
"phonenumber": null,
"type": 3
},
{
"service": "CFG27259",
"orderable": true,
"phonenumber": null,
"type": 3
}
]
}
}
}
},
"address": {
"province": "Zuid-Holland",
"municipality": "Katwijk",
"city": "Rijnsburg",
"zipcode": "2231BZ",
"street": "Laan van Verhof",
"housenr": 3,
"housenrext": "",
"latitude": "52.185709",
"longitude": "4.4527287"
},
"error": {}
}
JSON-RPC
carriercheck()
Since v1.10.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| housenr | integer | |
| housenrext | string | |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. |
| carrier | enum | Enum options:Fiber|Copper. An enumeration. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| line | object, any of | |
| kind | object | Enum options:Copper. Declares this object to describe a Copper endpoint |
| status | object | Service is possible or not. |
| number | string | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| carrier-vendor-id | string | |
| type | string | A string or no value at all. |
| connectionpointinfo | array | |
| connectionpointinfo[#] | object, any of | |
| cgb-name | string | Connection point name |
| isra-specs | string | ISRA point identification |
| number-of-nl1-lines | integer | Number of lines present at the location |
| nl1lines_available | integer | Number of unassigned lines at the location. Unassigned means that neither telephone nor broadband services are using these lines. |
| number-of-nl2-lines | integer | |
| copperconnection | array | |
| copperconnection[#] | object | |
| current-typeofconnection | integer | An integer or no value at all. |
| current-phonenumber | string | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| current-telephony-type | string | A string or no value at all. |
| current-xdf-access-serviceid | string | |
| future-typeofconnection | integer | An integer or no value at all. |
| future-xdf-access-serviceid | string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| future-phonenumber | string | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| future-telephony-type | string | A string or no value at all. |
| nid | string | |
| futurenid | string | |
| bonding-allowed | integer | An integer or no value at all. |
| plan-date | string | A string or no value at all. |
| cable-length | integer | An integer or no value at all. |
| san-only | string | A string or no value at all. |
| connectionpointinfo[#] | object, any of | |
| incomplete | boolean | |
| isra-specs | string | ISRA point identification |
| plan-date | string | A string or no value at all. |
| isra-pin | integer | An integer or no value at all. |
| line | object, any of | |
| kind | object | Enum options:Fiber. undefined |
| areapop | string | |
| carrier-vendor-id | string | |
| connectionpointinfo | array | |
| connectionpointinfo[#] | object | |
| fiber-terminationpoint-id | string | |
| ftu-type | string | A string or no value at all. |
| fiberconnection | array | |
| fiberconnection[#] | object | |
| current-typeofconnection | integer | |
| current-xdf-access-serviceid | string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| future-typeofconnection | integer | An integer or no value at all. |
| futurenid | string | |
| nid | string | |
| future-xdf-access-serviceid | string | Service label, matches the carrier's nid when the service is provided by Nextpertise. |
| carrier-status | string | A string or no value at all. |
| nl-type | string, any of | |
| nl-type | integer, any of | |
| plan-date | string | A string or no value at all. |
| has-date | string | A string or no value at all. |
Examples
Request example
{
"housenr": 2,
"housenrext": null,
"zipcode": "2408ZE",
"carrier": "Copper"
}
Reply example
{
"line": {
"kind": "Copper",
"status": null,
"number": null,
"vendor": "MDF",
"type": null,
"connectionpoint": [
{
"name": "Al-C",
"isra": "001/B/TR/TECHNISCHE RUI",
"nl1lines": 150,
"nl1lines_available": 137,
"nl2lines": 31,
"connection": [
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CGR56426",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CGS06036",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CHJ54631",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 2,
"number": "0172653748",
"phonetype": "POTS",
"serviceid": null,
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CFQ22670",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 2,
"number": "0172470731",
"phonetype": "POTS",
"serviceid": null,
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 2,
"number": "0172475933",
"phonetype": "POTS",
"serviceid": null,
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CGT35910",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CFQ67194",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 2,
"number": "0172474101",
"phonetype": "POTS",
"serviceid": null,
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 2,
"number": "0172471383",
"phonetype": "POTS",
"serviceid": null,
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 3,
"number": null,
"phonetype": null,
"serviceid": "CDK84267",
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 2,
"number": "0172478658",
"phonetype": "POTS",
"serviceid": null,
"futuretype": 9,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
},
{
"type": 0,
"number": null,
"phonetype": null,
"serviceid": null,
"futuretype": 0,
"futureserviceid": null,
"futurenumber": null,
"futurephonetype": null,
"nid": null,
"futurenid": null
}
],
"bonding_allowed": 0,
"plan_date": null,
"cable_length": 13,
"san_only": "False"
}
],
"plan_date": null,
"isra_pin": null
}
}
Request example
{
"housenr": 10,
"housenrext": null,
"zipcode": "2408ZE",
"carrier": "Fiber"
}
Reply example
{
"line": {
"kind": "Fiber",
"areapop": "al-3c",
"vendor": "REGG",
"connectionpoint": [
{
"id": "0",
"ftu_type": "FTU_GN02",
"connection": [
{
"type": 5,
"odfid": "REF0002736675",
"futuretype": 9,
"futurenid": null,
"nid": null,
"futureodfid": null
}
],
"carrier_status": "O",
"nlstype": "MIGRATE",
"plan_date": "20120604",
"has_date": "20120604"
}
]
}
}
JSON-RPC
list_providers()
Since v1.16.0
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| providers | array | |
| providers[#] | string |
Examples
Request example
{}
Reply example
{
"providers": [
"TELE2",
"KPNWEAS",
"KPNWBA",
"EUROFIBER",
"ZIGGO",
"WAUWAU",
"NDIX"
]
}
Broadband-basic-release
https://api.nextpertise.nl/broadband/basic/release
JSON-RPC
zipcode()
Since v1.0.0
Data needed to request a zipcode
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string | House number suffix. |
| filter | object | |
| provider | array | |
| provider[#] | enum | Enum options:TELE2|KPNWEAS|KPNWBA|EUROFIBER|ZIGGO|WAUWAU|NDIX. An enumeration. |
| connectionpoint | string | The ISRA-specs to retrieve specifically. This is used when the connectionpoints all list incomplete. You should only input the ISRA-specs not the full name, so it should look like '001' |
| timeout | number | The amount of time we wait for the total request to take. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| available | object | Maps providers to availabities |
| KPNWBA | object | |
| KPNWEAS | object | |
| TELE2 | object | |
| EUROFIBER | object | |
| ZIGGO | object | |
| NDIX | object | |
| WAUWAU | object | |
| address | object | |
| housenr | integer | |
| housenrext | string | |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| street | string | |
| city | string | |
| province | string | |
| municipality | string | |
| latitude | string | |
| longitude | string | |
| error | object |
Examples
Request example
{
"zipcode": "2408ZE",
"housenr": 10,
"housenrext": null,
"filter": {
"provider": [
"TELE2"
],
"connectionpoint": null,
"timeout": 15
}
}
Reply example
{
"available": {
"TELE2": {
"Fiber": {
"max_download": 10485760,
"max_upload": 10485760,
"area": "4",
"distance": "Fiber 4-Onnet",
"carrier": "Fiber"
}
}
},
"address": {
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"city": "Alphen aan den Rijn",
"zipcode": "2408ZE",
"street": "Zuidpoolsingel",
"housenr": 10,
"housenrext": "",
"latitude": "52.1266051",
"longitude": "4.6533684"
},
"error": {}
}
Request example
{
"zipcode": "2408ZE",
"housenr": 10,
"housenrext": null,
"filter": {
"provider": [],
"connectionpoint": null,
"timeout": 15
}
}
Reply example
{
"available": {
"WAUWAU": {},
"EUROFIBER": {
"Fiber": {
"max_download": 1000000,
"max_upload": 1000000,
"area": "",
"distance": "Onnet",
"carrier": "Fiber"
}
},
"KPNWBA": {
"Fiber": {
"max_download": 524000,
"max_upload": 524000,
"area": "",
"distance": "",
"carrier": "Fiber"
}
},
"KPNWEAS": {
"Fiber": {
"max_download": 1000000,
"max_upload": 1000000,
"area": "B",
"distance": "Nearnet;NLS-3",
"carrier": "Fiber"
}
},
"NDIX": {},
"TELE2": {
"Fiber": {
"max_download": 10485760,
"max_upload": 10485760,
"area": "4",
"distance": "Fiber 4-Onnet",
"carrier": "Fiber"
}
},
"ZIGGO": {
"Fiber": {
"max_download": 1000000,
"max_upload": 1000000,
"area": "",
"distance": "nearnet tot 250 meter",
"carrier": "Fiber"
}
}
},
"address": {
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"city": "Alphen aan den Rijn",
"zipcode": "2408ZE",
"street": "Zuidpoolsingel",
"housenr": 10,
"housenrext": "",
"latitude": "52.1266051",
"longitude": "4.6533684"
},
"error": {}
}
Broadband-diagnostics
https://api.nextpertise.nl/broadband/diagnostics/v1
JSON-RPC
diagnose()
Since v1.7.0
Requests a diagnostic report of a designated circuit.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| kind | enum | Enum options:port_status|line_analysis. Defines the requested report type |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| kind | enum | Enum options:port_status|line_analysis. undefined |
| status | array, one of | DSLAM port status as reported by KPN |
| status[#] | object | |
| operation | object | |
| stability | string | |
| linesync | boolean | |
| laststatus | string | |
| configuration | object | |
| cpetype | string | |
| dsltype | string | |
| parameter | object | |
| ^(lqd.parameter.|lqd.atm.).+ | object | |
| downstream | string | |
| unit | string | |
| upstream | string | |
| diagnostics | array | |
| diagnostics[#] | object | |
| explanation | string | |
| probablecause | string | |
| status | object, one of | SELT line status as reported by KPN |
| ScanDetails | object | |
| ScanName | string | |
| ProgressId | string | |
| ScanResponses | array | |
| ScanResponses[#] | object | |
| ExitValue | string | |
| Answer | string | |
| Detail | string | |
| TransactionDetails | string | |
| ErrorDetails | object | |
| ErrorCode | string | |
| ErrorDescription | string | |
| status | object, one of | Fiber (FttH/FttO/GPON) line status as reported by KPN |
| NetworkInformationDetails | object | |
| ReadCode | string | |
| ProgressId | string | |
| NetworkInformationResponse | string | |
| TransactionDetails | string | |
| ErrorDetails | object | |
| ErrorCode | string | |
| ErrorDescription | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "diagnose",
"params": {
"kind": "port_status",
"nid": "2408ZE000100102"
}
}
Reply example
{
"result": {
"kind": "port_status",
"status": [
{
"configuration": {
"cpetype": "",
"dsltype": ""
},
"operation": {
"stability": "",
"laststatus": "",
"linesync": false
},
"parameter": {},
"diagnostics": []
}
]
},
"jsonrpc": "2.0",
"id": 1
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "diagnose",
"params": {
"kind": "line_analysis",
"nid": "2408ZE000100102"
}
}
Reply example
{
"id": 1,
"result": {
"kind": "line_analysis",
"status": {
"ScanResponses": [
{
"Detail": "",
"ExitValue": "209",
"Answer": "request received, processing asynchronous"
}
],
"ScanDetails": {
"ProgressId": "27549585443434265",
"ScanName": "SELT"
},
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
}
},
"jsonrpc": "2.0"
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "diagnose",
"params": {
"nid": "2408ZE000100101",
"kind": "line_analysis"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"status": {
"NetworkInformationDetails": {
"ReadCode": "fiber",
"ProgressId": "77159350791453332"
},
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
},
"kind": "line_analysis"
}
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "diagnose",
"params": {
"nid": "2408ZE000100101",
"kind": "line_analysis"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"status": {
"NetworkInformationDetails": {
"ReadCode": "ontunistatus",
"ProgressId": "77159350791453332"
},
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
},
"kind": "line_analysis"
}
}
JSON-RPC
force_disconnect()
Since v1.7.0
Disconnects a circuit forcing it to initiate a new login.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "force_disconnect",
"params": {
"nid": "2408ZE000100102"
}
}
Reply example
{
"result": {},
"jsonrpc": "2.0",
"id": 1
}
JSON-RPC
get_authlog()
Since v1.7.0
Requests logs for a given circuit, optionally after a given moment.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| after | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| log_entries | array | |
| log_entries[#] | object | |
| username | string | |
| loginstatus | enum | Enum options:ok|incorrect|. undefined |
| datetime | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_authlog",
"params": {
"nid": "2408ZE000100102",
"after": "2018-01-29T17:18:00Z"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"log_entries": [
{
"username": "user@realm",
"loginstatus": "ok",
"datetime": "2018-01-29T17:17:27Z"
},
{
"username": "user@realm",
"loginstatus": "ok",
"datetime": "2018-01-29T18:15:00Z"
},
{
"username": "user@realm",
"loginstatus": "incorrect",
"datetime": "2018-02-02T19:16:10Z"
}
]
}
}
JSON-RPC
get_report()
Since v1.7.0
Fetch a stored diagnostic report.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| uuid | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| data | array | |
| data[#] |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_report",
"params": {
"uuid": "51175922778160569"
}
}
Reply example
{
"id": 1,
"result": {
"data": [
{
"status": [
{
"configuration": {
"cpetype": "Unknown",
"dsltype": "non.shdsl.opermode vdsl2.g9932.profile.17a, line.type.pots,g.inp,sra,vectored"
},
"diagnostics": [],
"operation": {
"linesync": true,
"laststatus": "20190709080119",
"stability": "STABLE"
},
"parameter": {
"lqd.parameter.noise.margin": {
"unit": "dB",
"downstream": "7.1",
"upstream": "5.5"
},
"lqd.parameter.actual.bitrate": {
"unit": "kb/s",
"downstream": "51998.0",
"upstream": "10445.0"
},
"lqd.parameter.loop.attenuation": {
"unit": "dB",
"downstream": "21.5",
"upstream": "14.4"
},
"lqd.parameter.rel.capacity.occupation": {
"unit": "%",
"downstream": "93.0",
"upstream": "97.0"
},
"lqd.parameter.attenuation": {
"unit": "dB",
"downstream": "19.2",
"upstream": "14.2"
},
"lqd.parameter.actual.psd": {
"unit": "dBm/Hz",
"downstream": "-57.6",
"upstream": "-55.6"
},
"lqd.parameter.attainable.bitrate": {
"unit": "kb/s",
"downstream": "56281.0",
"upstream": "10432.0"
},
"lqd.parameter.power": {
"unit": "dBm",
"downstream": "10.7",
"upstream": "6.4"
}
}
}
],
"kind": "port_status"
}
]
},
"jsonrpc": "2.0"
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_report",
"params": {
"uuid": "16295295192183708"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"data": [
{
"status": {
"ScanDetails": {
"ScanName": "SELT",
"ProgressId": "16295295192183708"
},
"ScanResponses": [
{
"ExitValue": "209",
"Answer": "request received, processing asynchronous",
"Detail": ""
}
],
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
},
"kind": "line_analysis"
},
{
"status": {
"ScanDetails": {
"ScanName": "SELT",
"ProgressId": "16295295192183708"
},
"ScanResponses": [
{
"ExitValue": "1",
"Answer": "Inspectiouuid: 2107524\n Meting van: ASD-ATP-DSLA-1:1-1-1-31\n -----------------------------\n Fault domain End User\n (no modem detected)\n\n ",
"Detail": "Resultcode = 10\n Inspectiouuid = 2107524\n "
}
],
"TransactionDetails": "20201001145126",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": null
}
},
"kind": "line_analysis"
}
]
}
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_report",
"params": {
"uuid": "16295295192183708"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"data": [
{
"status": {
"ScanDetails": {
"ScanName": "SELT",
"ProgressId": "16295295192183708"
},
"ScanResponses": [
{
"ExitValue": "209",
"Answer": "request received, processing asynchronous",
"Detail": ""
}
],
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
},
"kind": "line_analysis"
},
{
"status": {
"ScanDetails": {
"ScanName": "SELT",
"ProgressId": "16295295192183708"
},
"ScanResponses": [
{
"ExitValue": "1",
"Answer": "Inspectiouuid: 2107524\n Meting van: ASD-ATP-DSLA-1:1-1-1-31\n -----------------------------\n Fault domain End User\n (no modem detected)\n\n ",
"Detail": "Resultcode = 10\n Inspectiouuid = 2107524\n "
},
{
"ExitValue": "1",
"Answer": "Inspectiouuid: 2107524\n Meting van: ASD-ATP-DSLA-1:1-1-1-32\n -----------------------------\n Fault domain End User\n (no modem detected)\n\n ",
"Detail": "Resultcode = 10\n Inspectiouuid = 2107524\n "
}
],
"TransactionDetails": "20201001145126",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": null
}
},
"kind": "line_analysis"
}
]
}
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_report",
"params": {
"uuid": "51175922778160569"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"data": [
{
"status": {
"NetworkInformationDetails": {
"ReadCode": "fiber",
"ProgressId": "51175922778160569"
},
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
},
"kind": "line_analysis"
},
{
"status": {
"NetworkInformationDetails": {
"ReadCode": "fiber",
"ProgressId": "51175922778160569"
},
"NetworkInformationResponse": {
"Parameter": [
{
"Key": "last-status-change",
"Value": "80 days 13 hrs 43 mins 32 secs ago"
},
{
"Key": "line-status",
"Value": "up"
},
{
"Key": "vlans",
"Value": "6;8"
},
{
"Key": "technology-type",
"Value": "GoF"
},
{
"Key": "mac-addressess",
"Value": "VLAN-6: NONE; VLAN-8: NONE"
}
]
},
"TransactionDetails": "20201113164349",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": null
}
},
"kind": "line_analysis"
}
]
}
}
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_report",
"params": {
"uuid": "66323702279249538"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"data": [
{
"status": {
"NetworkInformationDetails": {
"ReadCode": "ontunistatus",
"ProgressId": "66323702279249538"
},
"TransactionDetails": "",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": ""
}
},
"kind": "line_analysis"
},
{
"status": {
"NetworkInformationDetails": {
"ReadCode": "ontunistatus",
"ProgressId": "66323702279249538"
},
"NetworkInformationResponse": {
"Parameter": [
{
"Key": "advice-code",
"Value": "3"
},
{
"Key": "ont-lan-administrative-status",
"Value": "up"
},
{
"Key": "ont-lan-operational-status",
"Value": "up"
},
{
"Key": "ont-lan-last-status-change",
"Value": "0004-00:10:52"
}
]
},
"TransactionDetails": "20201130130804",
"ErrorDetails": {
"ErrorCode": "0",
"ErrorDescription": null
}
},
"kind": "line_analysis"
}
]
}
}
JSON-RPC
list_reports()
Since v1.7.0
Produce a list of the stored diagnostic reports.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| kind | enum | Enum options:port_status|line_analysis. Defines the requested report type |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| list | array | |
| list[#] | object | |
| updated | string | |
| uuid | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_reports",
"params": {
"kind": "port_status",
"nid": "1062AB001370101"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"list": [
{
"updated": "2018-02-01 15:58:48",
"uuid": "25437187642824708"
},
{
"updated": "2018-02-02 13:04:58",
"uuid": "25460733154473988"
}
]
}
}
Postcodes
https://api.nextpertise.nl/postcodes/v1
JSON-RPC
get_housenrs()
Since v1.2.0
Fetches a list of house numbers belonging to a specific zipcode.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| housenrs | array | |
| housenrs[#] | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_housenrs",
"params": {
"zipcode": "2408ZE"
}
}
Reply example
{
"result": {
"housenrs": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
},
"id": 1,
"jsonrpc": "2.0"
}
JSON-RPC
get_housenrext()
Since v1.2.0
Fetches the address and a list of house number extensions for a specific zipcode/housenr combination.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| CADASTRAL | object | |
| address | object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null | |
| housenrexts | array | |
| housenrexts[#] | string | |
| KPNWBA | object | |
| housenrexts | array | |
| housenrexts[#] | string | |
| KPNWEAS | object | |
| housenrexts | array | |
| housenrexts[#] | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_housenrext",
"params": {
"zipcode": "2408ZE",
"housenr": 2
}
}
Reply example
{
"result": {
"KPNWEAS": {
"housenrexts": [
"",
"A",
"GML",
"KT",
"KT01",
"MST"
]
},
"CADASTRAL": {
"housenrexts": [
""
],
"address": {
"street": "Zuidpoolsingel",
"latitude": "52.1265701",
"zipcode": "2408ZE",
"municipality": "Alphen aan den Rijn",
"city": "Alphen aan den Rijn",
"longitude": "4.6538731",
"housenr": 2,
"province": "Zuid-Holland"
}
},
"KPNWBA": {
"housenrexts": [
"",
"A",
"GML",
"KT",
"KT01",
"MST"
]
}
},
"jsonrpc": "2.0",
"id": 1
}
Product
https://api.nextpertise.nl/product/v1
JSON-RPC
list_products()
Since v1.12.0
Lists all products available to you.
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| products | array | |
| products[#] | object | |
| category | string | |
| product_id | integer | |
| depends_on | array | |
| depends_on[#] | integer | |
| supplier | string | |
| name | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_products",
"params": {}
}
Reply example
{
"id": 1,
"result": {
"products": [
{
"name": "ADSL (non-shared line, NLS1 ZTL)",
"depends_on": [],
"supplier": "KPNWBA",
"product_id": 108,
"category": "carrier"
},
{
"name": "GFR Circuit 22Mb/1Mb",
"depends_on": [
610
],
"supplier": "KPNWBA",
"product_id": 311,
"category": "circuit"
},
{
"name": "24x7 SLA",
"depends_on": [
108
],
"supplier": "KPNWBA",
"product_id": 759,
"category": "sla"
}
]
},
"jsonrpc": "2.0"
}
Enduser
https://api.nextpertise.nl/enduser/v1
JSON-RPC
del_enduser()
Since v1.22.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| uuid | string | |
| customer_id | integer |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "del_enduser",
"params": {
"uuid": "abcde123-0123-4abc-9876-012345678912"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
JSON-RPC
get_enduser()
Since v1.22.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| uuid | string | |
| customer_id | integer, null |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| enduser | object | |
| uuid | string | |
| company_name | string, null | |
| phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| address | object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_enduser",
"params": {
"uuid": "abcde123-0123-4abc-9876-012345678912"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"enduser": {
"uuid": "abcde123-0123-4abc-9876-012345678912",
"company_name": "Nextpertise Office",
"phonenumber": "0887775200",
"address": {
"zipcode": "2408ZE",
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"housenr": 10,
"housenrext": null,
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"latitude": "52.1266051",
"longitude": "4.6533684"
}
}
}
}
JSON-RPC
list_endusers()
Since v1.22.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| customer_id | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| endusers | array | |
| endusers[#] | object | |
| uuid | string | |
| company_name | string, null | |
| phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| address | object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_endusers",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"endusers": [
{
"uuid": "abcde123-0123-4abc-9876-012345678912",
"company_name": "Nextpertise Office",
"phonenumber": "0887775222",
"address": {
"zipcode": "2408ZE",
"housenr": 10,
"housenrext": "",
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"latitude": "52.1266051",
"longitude": "4.6533684"
}
},
{
"uuid": "fe1f15a3-b255-4572-afeb-1edd961137b9",
"company_name": "Dierenhoekje",
"phonenumber": "0101234567",
"address": {
"zipcode": "1075SC",
"housenr": 53,
"housenrext": null,
"city": "Amsterdam",
"street": "Zeilstraat",
"province": "Noord-Holland",
"municipality": "Amsterdam",
"latitude": "52.3506857",
"longitude": "4.8535913"
}
}
]
}
}
JSON-RPC
set_enduser()
Since v1.22.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| enduser | object | |
| uuid | string, null | |
| company_name | string, null | |
| phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| address | object | |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | |
| housenrext | string, null | A string or no value at all. |
| customer_id | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| enduser | object | |
| uuid | string | |
| company_name | string, null | |
| phonenumber | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| address | object | A complete address with province, municipality, latitude and longitude. |
| zipcode | string | Regex:^[0-9]{4}[A-Z]{2}$. The zipcode must conform to the Dutch postcode format. Note that the initial digit is not allowed to be '0' unless when testing. |
| housenr | integer | The house number that with the zipcode identifies an address. |
| housenrext | string, null | House number suffix. |
| street | string, null | The street name. |
| city | string, null | The city name. |
| province | string, null | |
| municipality | string, null | |
| latitude | string, null | |
| longitude | string, null |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "set_enduser",
"params": {
"enduser": {
"company_name": "Nextpertise Office",
"phonenumber": "0887775222",
"address": {
"zipcode": "2408ZE",
"housenr": 2,
"housenrext": null
}
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"enduser": {
"uuid": "abcde123-0123-4abc-9876-012345678912",
"company_name": "Nextpertise Office",
"phonenumber": "0887775222",
"address": {
"zipcode": "2408ZE",
"housenr": 10,
"housenrext": "",
"city": "Alphen aan den Rijn",
"street": "Zuidpoolsingel",
"province": "Zuid-Holland",
"municipality": "Alphen aan den Rijn",
"latitude": "52.1266051",
"longitude": "4.6533684"
}
}
}
}
Email
https://api.nextpertise.nl/email/v1
JSON-RPC
create_forwarder()
Since v1.3.5
Create a forwarder for the client of the customer.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailbox | string | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). Full address of the mailbox localpart@example.com |
| recipients | array | List of email addresses to which incoming mail is forwarded. |
| recipients[#] | string | Regex:(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_forwarder",
"params": {
"mailbox": "forwarder@mail.nl",
"recipients": [
"mailnbox@mail.nl"
]
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
JSON-RPC
create_mailbox()
Since v1.3.5
Request an action on a mailbox for the client of the customer.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailbox | string | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). Full address of the mailbox localpart@example.com |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| password | string, one of | The password assigned to the mailbox when it is created. |
| message | string, one of |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_mailbox",
"params": {
"mailbox": "test@mail.nl"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"password": "735029e0f8544fd09fb64963da0aaba0"
}
}
JSON-RPC
delete_forwarder()
Since v1.3.5
Request an action on a mailbox for the client of the customer.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailbox | string | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). Full address of the mailbox localpart@example.com |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "delete_forwarder",
"params": {
"mailbox": "forwarder123@mail.nl"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
JSON-RPC
delete_mailbox()
Since v1.3.5
Request an action on a mailbox for the client of the customer.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailbox | string | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). Full address of the mailbox localpart@example.com |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "delete_mailbox",
"params": {
"mailbox": "mailbox@mail.nl"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
JSON-RPC
get_forwarders()
Since v1.3.5
Get all forwarders.
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| forwarders | array | |
| forwarders[#] | object | |
| mailbox | string | |
| recipients | array |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_forwarders",
"params": {}
}
Reply example
{
"result": {
"forwarders": [
{
"mailbox": "forwarder1@mail.nl",
"recipients": [
"mailbox@mail.nl"
]
},
{
"mailbox": "forwarder2@mail.nl",
"recipients": [
"mailbox@mail.nl"
]
}
]
},
"jsonrpc": "2.0",
"id": 1
}
JSON-RPC
get_mailbox_usage()
Since v1.3.5
Get a list with all mailboxes and their usage for a given year and month.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| year | integer | |
| month | integer |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| usage | array | |
| usage[#] | object | |
| usage | number | |
| status | string | |
| mailbox | string, null | |
| year | integer | |
| month | integer |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_mailbox_usage",
"params": {
"year": 2017,
"month": 11
}
}
Reply example
{
"result": {
"usage": [
{
"month": 11,
"usage": 663.962,
"status": "AVAILABLE",
"mailbox": "mailbox@mail.nl",
"year": 2017
},
{
"month": 11,
"usage": 159.949,
"status": "AVAILABLE",
"mailbox": "user2@mail.nl",
"year": 2017
}
]
},
"id": 1,
"jsonrpc": "2.0"
}
JSON-RPC
get_mailboxes()
Since v1.3.5
Get a list with all mailboxes.
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailboxes | array | |
| mailboxes[#] | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_mailboxes",
"params": {}
}
Reply example
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"mailboxes": [
"mailbox@mail.nl",
"user2@mail.nl"
]
}
}
JSON-RPC
get_ordered_products()
Since v1.4.0
Get a list of the ordered email products.
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| products | object | Group ordered products by product category |
| array | List of ordered email products. | |
| email[#] | object | Describe a single email product |
| product | object | |
| product_id | integer | Identifies an individual product by numeric id. |
| name | string, null | The product name. |
| description | null, string | Describes the product. |
| extrainfo | null, string | Additional information about the product |
| state | enum | Enum options:PROCESSING|ACTIVE|TERMINATED|CANCELLED|CANCEL_REQUESTED|CANCEL_REQUEST_CONFIRMED|TERMINATION_REQUESTED|TERMINATION_REQUEST_CONFIRMED|CHANGE_REQUESTED|CHANGE_REQUEST_CONFIRMED|CHANGE_REQUEST_PROCESSING_CONFIRMED|CHANGE_REQUEST_PROCESSING_CONFIRMED|CHANGE_REQUEST_TERMINATION_CONFIRMED. State the product is in. One of PROCESSING Product is being ordered. ACTIVE Product is operational. TERMINATED Product is terminated. |
| address | string | Email address associated with the mailbox or forwarder. |
| order_date | string | Regex:^[1-9][0-9]{3}-[01][0-9]-[0-3][0-9]$. Date in international format YYYY-MM-DD |
| type | enum | Enum options:mailbox|forwarder. Defines type of product. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_ordered_products",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"products": {
"email": [
{
"product": {
"description": null,
"extrainfo": null,
"product_id": 598,
"name": "Mailbox"
},
"type": "mailbox",
"order_date": "2017-11-01",
"state": "ACTIVE",
"id": 9089,
"address": "mailbox@mail.nl"
},
{
"product": {
"description": null,
"extrainfo": null,
"product_id": 598,
"name": "Mailbox"
},
"type": "mailbox",
"order_date": "2017-11-01",
"state": "ACTIVE",
"id": 9090,
"address": "user2@mail.nl"
}
]
}
}
}
JSON-RPC
update_forwarder()
Since v1.3.5
Update a forwarder for the client of the customer.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailbox | string | Regex:(^[a-zA-Z0-9_.+-/*]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). Full address of the mailbox localpart@example.com |
| recipients | array | List of email addresses to which incoming mail is forwarded. |
| recipients[#] | string | Regex:(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$). |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "update_forwarder",
"params": {
"mailbox": "forwarder@mail.nl",
"recipients": [
"mailbox@mail.nl",
"user2@mail.nl"
]
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
JSON-RPC
update_password()
Since v1.3.5
Change the password of a mailbox.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| mailbox | string | Full address of the mailbox localpart@example.com |
| password | string | The new password for the mailbox. |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "update_password",
"params": {
"mailbox": "mailbox@mail.nl",
"password": "newpassword"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Attachments
https://api.nextpertise.nl/attachments/v1
JSON-RPC
upload()
Upload attachment
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| context | string | |
| file | string | |
| filename | string | |
| description | string | |
| customer_code | string | Regex:^DB[0-9]{3,}$. Identifies a customer by this key |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| attachment_uuid | string |
Examples
Support
https://api.nextpertise.nl/support/v1
JSON-RPC
create_ticket()
Since v1.21.0
Creates a single ticket with opening comment.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| subject | string | The title of the ticket. |
| comment | string | The opening comment of the ticket. Essentially the body. |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| reference | string | External support reference. |
| contact | object | Contact info |
| phone | string, null | Regex:^0([1-7][0-9]|85|88)[0-9]{7}$. Dutch national telephone number |
| name | string | |
| technical_specifications | string | Add technical details to the ticket. |
| attachments | array | List of attachment_uuid. |
| attachments[#] | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| id | integer | The ID of the newly created ticket. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_ticket",
"params": {
"subject": "Connection down for Nextpertise Office",
"comment": "Problem persists after a router reboot. Please help me!",
"nid": "2408ZE000100100",
"reference": "#123 - Nextpertise Office",
"contact": {
"name": "John Doe",
"phone": "0612345678"
},
"attachments": []
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"id": 12345
}
}
JSON-RPC
get_ticket()
Since v1.21.0
Returns a single ticket with comments.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| id | integer | The ID of the ticket. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| id | integer | The ID of the ticket. |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| reference | null, string | External support reference. |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| updated_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| subject | string | The title of the ticket. |
| description | string | Opening comment of ticket. Is the same as the body of the first comment in 'comments'. |
| status | enum | Enum options:new|open|pending|solved|closed. Current status of the ticket. |
| comments | array | List of all comments on ticket, ordered by date. |
| comments[#] | object | |
| body | string | Comment text. Stripped of inline attachments & HTML. |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| author | object | Support user information. |
| name | string | |
| photo | null, object | Profile picture of author. Can be null. |
| thumbnail_url | null, string | Direct URL to a thumbnail of the file. |
| url | string | Direct url to file. |
| attachments | array | List of attached files. |
| attachments[#] | object | |
| file_name | string | |
| size | null, integer | File size in bytes. |
| url | string | Direct url to file. |
| thumbnail_url | null, string | Direct URL to a thumbnail of the file. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "create_ticket",
"params": {
"id": 12345
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"id": 12345,
"nid": "2408ZE000100100",
"reference": "#123 - Nextpertise Office",
"subject": "Connection down for Nextpertise Office",
"description": "Problem persists after a router reboot. Please help me!\n\nContactpersoon:\nJohn Doe\n0612345678",
"status": "new",
"created_at": "2020-04-10T13:40:35Z",
"updated_at": "2020-04-10T13:40:35Z",
"comments": [
{
"body": "Problem persists after a router reboot. Please help me!\n\nContactpersoon:\nJohn Doe\n0612345678",
"created_at": "2020-04-10T13:40:35Z",
"attachments": [],
"author": {
"name": "johndo@company.com",
"photo": null
}
}
]
}
}
JSON-RPC
list_tickets()
Since v1.21.0
Returns a list of tickets.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| closed | boolean | Whether or not closed tickets should be returned. Defaults to true. |
| pagination | object | Used to limit the amount of tickets returned. |
| per_page | integer | Amount of tickets per page (request). |
| page | integer | The requested page-index, starts at 1. |
| filter | object | Filter tickets. |
| search | string | Filter tickets by search string. |
| sort | object | Sort tickets. Can only sort by one key at a time. By default all tickets are sorted in descending order of last update time. |
| updated_at | enum | Enum options:ASC|DESC. Sort by date of last update. |
| created_at | enum | Enum options:ASC|DESC. Sort by date of creation. |
| id | enum | Enum options:ASC|DESC. Sort by ticket number. |
| requester | enum | Enum options:ASC|DESC. Sort by ticket creator. |
| status | enum | Enum options:ASC|DESC. Sort by ticket status. |
| subject | enum | Enum options:ASC|DESC. Sort by ticket subject. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| ticket_count | integer | Total amount of tickets found for the user & filter. |
| pagination | object | Information about the pagination settings. If a '..._page' returns null, the page does not exist. |
| previous_page | integer, null | An integer or no value at all. |
| next_page | integer, null | An integer or no value at all. |
| per_page | integer | Max amount of tickets per page. |
| tickets | array | List of tickets. |
| tickets[#] | object | |
| requester | object | Support user information. |
| name | string | |
| photo | null, object | Profile picture of author. Can be null. |
| thumbnail_url | null, string | Direct URL to a thumbnail of the file. |
| url | string | Direct url to file. |
| created_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| updated_at | string | Regex:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$. Datetime in UTC format YYYY-MM-DDThh:mm:ssZ |
| nid | string, null | Regex:^[0-9]{4}[A-Z]{2}[0-9]{5}[0-9A-Z]{4}$. Carrier or circuit identification. To harmonize the way ordered broadband products are identified. |
| status | enum | Enum options:new|open|pending|solved|closed. Current status of the ticket. |
| reference | string, null | External support reference. |
| subject | string | The title of the ticket. |
| description | string | Opening comment of ticket. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_tickets",
"params": {
"pagination": {
"per_page": 50,
"page": 1
},
"filter": {
"search": "Nextpertise"
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"tickets": [
{
"id": 12345,
"nid": "2408ZE000080100",
"reference": "#123 - Nextpertise Office",
"subject": "Connection down for Nextpertise Office",
"description": "Problem persists after a router reboot. Please help me!\n\nContactpersoon:\nJohn Doe\n0612345678\n\nTechnische specificaties:\ntech-specs",
"status": "closed",
"created_at": "2020-04-01T13:26:09Z",
"updated_at": "2020-04-02T15:02:21Z",
"requester": {
"name": "johndoe@company.com",
"photo": null
}
}
],
"pagination": {
"next_page": null,
"previous_page": null,
"per_page": 50
},
"ticket_count": 1
}
}
JSON-RPC
update_ticket()
Since v1.21.0
Updates a single ticket.
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| id | integer | The ID of the ticket. |
| comment | object | Adds a new comment to the ticket. |
| body | string | Comment text. |
| attachments | array | List of attachments uuid. |
| attachments[#] | string | |
| solved | boolean | Mark ticket as (un)solved. |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "update_ticket",
"params": {
"id": 12345,
"comment": {
"body": "Ticket update comment!"
},
"solved": false
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
User
https://api.nextpertise.nl/user/v1
JSON-RPC
get_profile()
Since v1.11.0
Get all information about a user's profile
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| username | string |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| user | object | |
| language | enum | Enum options:en-US|nl-NL. IETF BCP 47 language tag |
| firstname | string | |
| lastname | string | |
| username | string | |
| timezone | string | |
| notification | array | |
| security | object | Object containing security options. |
| totp_enabled | boolean | Whether or not TOTP based 2FA is enabled. |
| whitelist_enabled | boolean | Whether or not the IP whitelist is enabled. |
| whitelist | array | List of whitelisted IPV4s. |
| whitelist[#] | object | |
| ipv4 | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$. IP Address in CIDR notation. |
| description | string | |
| permissions | object | User permissions. |
| [a-z]- | object | |
| r | null, boolean | If true, user has read permission. |
| c | null, boolean | If true, user has create/edit permission. |
| d | null, boolean | If true, user has delete permission. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "get_profile",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"user": {
"language": "nl-NL",
"firstname": "Teun",
"lastname": "Ouwehand",
"username": "t90@nextpertise.nl"
},
"notification": [
"Broadband"
],
"security": {
"whitelist_enabled": true,
"totp_enabled": false,
"whitelist": [
{
"ipv4": "10.20.30.44/32",
"description": "Development VPS"
},
{
"ipv4": "1.2.3.4/30",
"description": "Nextpertise Office"
}
]
},
"permissions": {
"broadband": {
"show_prices": true,
"purchase": true
},
"user": {
"admin": true
}
}
}
}
JSON-RPC
list_profiles()
Since v1.23.0
List all profiles for loggedin users company
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| filter | object | |
| firstname | string | |
| lastname | string | |
| username | string | |
| language | string | |
| timezone | string | |
| sort | object | |
| firstname | enum | Enum options:ASC|DESC. undefined |
| lastname | enum | Enum options:ASC|DESC. undefined |
| username | enum | Enum options:ASC|DESC. undefined |
| language | enum | Enum options:ASC|DESC. undefined |
| timezone | enum | Enum options:ASC|DESC. undefined |
| paging | object | Request pagination of the result set. |
| offset | integer | First record to include in result set. |
| length | integer | Number of records to return, when the result set is smaller than this number it indicates that the last page is reached. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| count | integer | |
| profiles | array | |
| profiles[#] | object | |
| user | object | |
| language | enum | Enum options:en-US|nl-NL. IETF BCP 47 language tag |
| firstname | string | |
| lastname | string | |
| username | string | |
| timezone | string |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_profiles",
"params": {
"filter": {},
"sort": {
"username": "DESC"
},
"paging": {
"offset": 0,
"length": 2
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"profiles": [
{
"user": {
"language": "en-US",
"firstname": "Teun",
"lastname": "Ouwehand",
"username": "t90@nextpertise.nl"
}
},
{
"user": {
"language": "nl-NL",
"firstname": "Patrick",
"lastname": "Van der Valk",
"username": "ajvandervalk@nextpertise.nl"
}
}
],
"count": 5
}
}
JSON-RPC
set_profile()
Since v1.11.0
Set information about a user's profile
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| username | string | Regex:^(.+@.+\..+)$. |
| new_user | boolean | If true - create new user else edit user |
| user | object | |
| language | enum | Enum options:en-US|nl-NL. IETF BCP 47 language tag |
| firstname | string | |
| lastname | string | |
| timezone | string | |
| notification | array | |
| security | object | Object containing security options. |
| totp_enabled | boolean | Turn TOTP based 2FA on or off. Either TOTP or the whitelist needs to be enabled. The TOTP token is reset and returned after toggling this setting. |
| totp_reset | boolean | If true, the TOTP key will be reset. |
| whitelist_enabled | boolean | Turn the IP whitelist on or off. Either TOTP or the whitelist needs to be enabled. |
| whitelist | array | Sets whitelist to this list of IPV4s. |
| whitelist[#] | object | |
| ipv4 | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$. IP Address in CIDR notation. |
| description | string | |
| password | string | Update password. |
| password_reset | boolean | Reset password. |
| permissions | object | User permissions. |
| [a-z]- | object | |
| r | null, boolean | If true, user has read permission. |
| c | null, boolean | If true, user has create/edit permission. |
| d | null, boolean | If true, user has delete permission. |
Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| user | object | |
| language | enum | Enum options:en-US|nl-NL. IETF BCP 47 language tag |
| firstname | string | |
| lastname | string | |
| username | string | |
| timezone | string | |
| notification | array | |
| security | object | Object containing security options. |
| totp_enabled | boolean | Whether or not TOTP based 2FA is enabled. |
| whitelist_enabled | boolean | Whether or not the IP whitelist is enabled. |
| whitelist | array | List of whitelisted IPV4s. |
| whitelist[#] | object | |
| ipv4 | string | Regex:^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$. IP Address in CIDR notation. |
| description | string | |
| permissions | object | User permissions. |
| [a-z]- | object | |
| r | null, boolean | If true, user has read permission. |
| c | null, boolean | If true, user has create/edit permission. |
| d | null, boolean | If true, user has delete permission. |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "set_profile",
"params": {
"user": {
"lastname": "Ouwehand",
"firstname": "Teun",
"language": "nl-NL"
}
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"user": {
"language": "nl-NL",
"firstname": "Teun",
"lastname": "Ouwehand",
"username": "t90@nextpertise.nl"
},
"notification": [
"Broadband"
],
"security": {
"whitelist_enabled": true,
"totp_enabled": false,
"whitelist": [
{
"ipv4": "10.20.30.44/32",
"description": "Development VPS"
},
{
"ipv4": "1.2.3.4/30",
"description": "Nextpertise Office"
}
]
},
"permissions": {
"broadband": {
"show_prices": true,
"purchase": true
},
"user": {
"admin": true
}
}
}
}
JSON-RPC
del_profile()
Since v1.23.0
Request params
open_in_new
| Name | Type | Description |
|---|---|---|
| username | string |
Reply params
open_in_new
This method returns an empty object:
{}Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "del_profile",
"params": {
"username": "teun@nextpertise.nl"
}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"params": {}
}
JSON-RPC
list_apis()
Since v1.24.0
Request params
open_in_new
This method expects an empty object as input:
{}Reply params
open_in_new
| Name | Type | Description |
|---|---|---|
| permissions | object | |
| broadband|broadband-ordering|broadband-basic|broadband-diagnostics|email|postcodes|product|enduser|support|user | object | |
| r | boolean, null | |
| c | boolean, null | |
| d | boolean, null |
Examples
Request example
{
"jsonrpc": "2.0",
"id": 1,
"method": "list_apis",
"params": {}
}
Reply example
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"permissions": {
"broadband": {
"r": true,
"c": true,
"d": true
},
"broadband-ordering": {
"r": null,
"c": true,
"d": true
},
"broadband-basic": {
"r": true,
"c": null,
"d": null
},
"broadband-diagnostics": {
"r": true,
"c": null,
"d": null
},
"email": {
"r": true,
"c": true,
"d": true
},
"postcodes": {
"r": true,
"c": null,
"d": null
},
"product": {
"r": true,
"c": null,
"d": null
},
"enduser": {
"r": true,
"c": true,
"d": true
},
"support": {
"r": true,
"c": true,
"d": null
},
"user": {
"r": true,
"c": true,
"d": true
}
}
}
}
Release notes
https://api.nextpertise.nl
Changelog
Changed in version 1.27.0, released on Aug 6th, 2021.
- Add function get_carrier_products().
- Add function get_provider_products().
Changed in version 1.26.0, released on Jul 29th, 2021.
- Add function get_recent_transaction().
Changed in version 1.25.0, released on Dec 1st, 2020.
- Add function list_available_subnetsizes().
- Added support for Fiber (FttH/FttO/GPON) in diagnose() method
Changed in version 1.24.0, released on Nov 25th, 2020.
- Add function cancel_transaction().
- Add function get_transaction().
- Add function list_connections().
- Add function list_transactions().
- Add function list_apis().
Changed in version 1.23.0, released on Sep 24th, 2020.
- Add function list_profiles().
- Add function del_profile().
Changed in version 1.22.0, released on May 6th, 2020.
- Add chapter The Enduser API.
- Add function del_enduser().
- Add function get_enduser().
- Add function list_endusers().
- Add function set_enduser().
Changed in version 1.21.0, released on April 1st, 2020.
- Add chapter The Support API.
- Add function create_ticket().
- Add function get_ticket().
- Add function list_tickets().
- Add function update_ticket().
Changed in version 1.20.0, released on Feb 24th, 2020.
- Add function get_accesslist().
- Add function list_events().
- Add function list_accesslists().
- Add function list_ipvpns().
- Add function migrate_provisioning().
- Add function set_provisioning().
Changed in version 1.18.0, released on Oct 286th, 2019.
- Add function check_authentication().
Changed in version 1.17.0, released on Oct 2nd, 2019.
- Add function list_auth_realms().
Changed in version 1.16.0, released on Aug 9th, 2019.
- Add function list_providers().
- Add function list_providers().
Changed in version 1.12.0, released on Jul 8th, 2019.
- Add chapter The Product API.
- Add function set_tags().
- Add function list_products().
Changed in version 1.11.0, released on May 14th, 2019.
- Add chapter The User API.
- Add function get_profile().
- Add function set_profile().
Changed in version 1.10.0, released on Oct 8th, 2018.
- Add function carriercheck().
- Add function order_connection().
- Add function carriercheck().
Changed in version 1.7.0, released on Mar 29th, 2018.
- Add chapter The Broadband-diagnostics API.
- Add function diagnose().
- Add function force_disconnect().
- Add function get_authlog().
- Add function get_report().
- Add function list_reports().
Changed in version 1.4.0, released on Nov 16th, 2017.
- Add function get_ordered_products().
Changed in version 1.3.5, released on Jul 18th, 2017.
- Add chapter The Email API.
- Add function create_forwarder().
- Add function create_mailbox().
- Add function delete_forwarder().
- Add function delete_mailbox().
- Add function get_forwarders().
- Add function get_mailbox_usage().
- Add function get_mailboxes().
- Add function update_forwarder().
- Add function update_password().
Changed in version 1.2.0, released on May 9th, 2017.
- Add chapter The Postcodes API.
- Add function get_housenrs().
- Add function get_housenrext().
Changed in version 1.0.0, released on Jan 4th, 2017.
- Add chapter The Broadband-basic-release API.
- Add chapter The Broadband-release API.
- Add chapter The Broadband-basic API.
- Add chapter The Broadband API.
- Add function zipcode().
- Add function zipcode().
- Add function zipcode().
- Add function zipcode().