get_ordered_products()

The Broadband API

This function fetches all purchased broadband products.

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

Method

get_ordered_products

Input

Get ordered products.

https://api.nextpertise.nl/schemas/broadband/get_ordered_products_request_v1.json
Get a list of the ordered broadband products.
type object
properties

Output

Get ordered products.

https://api.nextpertise.nl/schemas/broadband/get_ordered_products_reply_v1.json
Get a list of the ordered broadband products.
type object
properties
  • products
Group ordered products by product category
type object
properties
  • broadband
List of ordered broadband products. Products are grouped by the connection they implement.
type array
items
Describe a single broadband connection
type object
properties
  • carrier
Carrier product
  • circuits
List of circuits (EVCs) over this carrier
type array
items
Circuit product
minItems 1
  • sla
Describe the SLA product covering this connection.
type object
properties
  • order_date
Optional date
  • state
Product state
  • product
Product
additionalProperties False
  • contract_period
Defines start and end of the minimum contract period.
type object
properties
  • to
Optional date
  • from
Optional date
additionalProperties False
  • address
Extended address
  • supplier
Connection supplier, structure of the entire object depends on this field.
type string
enum KPNWBA
  • location_contact
Who to reach at the location.
type object
properties
  • phonenumber
Telephone number
  • name
Name of the contact person.
type string
  • email
Email address of the contact person.
type string / null
  • company
Company name of the contact person.
type string / null
additionalProperties False
additionalProperties False
additionalProperties False
additionalProperties False

Example

Request

curl -u 'user:pass' https://api.nextpertise.nl/broadband/v1 -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "get_ordered_products",
    "params": {}
}' | jq .

Reply

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "products": {
            "broadband": [
                {
                    "circuits": [
                        {
                            "bandwidth_up": 1024,
                            "product": {
                                "extrainfo": null,
                                "product_id": 246,
                                "description": null,
                                "name": "Regular Circuit 16Mb/1Mb overbooking 1:25"
                            },
                            "premium": false,
                            "tags": [],
                            "bandwidth_down": 16000,
                            "vci": 35,
                            "vlan": null,
                            "nid": "2408ZE000020101",
                            "plan_date": "2014-10-10",
                            "state": "ACTIVE",
                            "online": "unknown",
                            "auth_user": null,
                            "order_date": "2015-12-18",
                            "vpi": 0,
                            "ipv4": null
                        },
                        {
                            "bandwidth_up": 128,
                            "product": {
                                "extrainfo": null,
                                "product_id": 324,
                                "description": null,
                                "name": "Premium Circuit 128Kb/128Kb overbooking 1:1"
                            },
                            "premium": true,
                            "tags": [],
                            "bandwidth_down": 128,
                            "vci": 38,
                            "vlan": null,
                            "nid": "2408ZE000020102",
                            "plan_date": "2014-10-10",
                            "state": "ACTIVE",
                            "online": "offline",
                            "auth_user": "<radius account>",
                            "order_date": "2015-12-18",
                            "vpi": 0,
                            "ipv4": "<ip address>"
                        }
                    ],
                    "contract_period": {
                        "to": "2015-10-07",
                        "from": "2014-10-07"
                    },
                    "carrier": {
                        "ftu_type": null,
                        "israpin": null,
                        "additional_israpin": null,
                        "carrier_type": "Copper_only",
                        "plan_date": "2014-10-10",
                        "data_technology": "ADSL2+",
                        "tags": [],
                        "product": {
                            "extrainfo": null,
                            "product_id": 108,
                            "description": null,
                            "name": "ADSL (non-shared line, NLS1 ZTL)"
                        },
                        "nid": "2408ZE000020100",
                        "state": "ACTIVE",
                        "base_technology": "POTS",
                        "phonenumber": null,
                        "order_date": "2015-12-18",
                        "israspecs": "001/B/TR/TECHNISCHE RUI"
                    },
                    "address": {
                        "province": "Zuid-Holland",
                        "city": "Alphen aan den Rijn",
                        "housenr": 2,
                        "municipality": "Alphen aan den Rijn",
                        "zipcode": "2408ZE",
                        "longitude": "4.6538731",
                        "housenrext": null,
                        "street": "Zuidpoolsingel",
                        "latitude": "52.1265701"
                    },
                    "supplier": "KPNWBA",
                    "location_contact": {
                        "phonenumber": "0793317414",
                        "email": null,
                        "name": "Patrick"
                    },
                    "sla": {
                        "order_date": "2015-12-18",
                        "product": {
                            "extrainfo": null,
                            "product_id": 606,
                            "description": null,
                            "name": "Best Effort SLA"
                        },
                        "state": "ACTIVE"
                    }
                }
            ]
        }
    }
}