Introduction

The Disturbance Detector API allows you to get an overview of all disturbances in the KPN network in the Netherlands.


API specification

Test the API on SwaggerHub


Base URL

https://api-prd.kpn.com/network/kpn/disturbance-detector


Conceptual model

Conceptual model


API workflow

Sequence diagram


How to...

Detect network disturbances

SwaggerHub:

  1. Check disturbance GET /failures.
  2. Click Try it out.
  3. Supply state.
  4. Click Execute.
  5. Check the response code and message.

Postman: 1. Request GET (DetectDisturbance). 2. Supply state. 3. Click Send. 4. Check the response code and message.

the result of the call will look like the following:

^^Response example^^
[
    {
        "id": 1212,
        "affected_elements_count": 3,
        "affected_customers_count": 549,
        "communicated_customers_sms_count": 348,
        "communicated_customers_email_count": 200,
        "type": "geographical-broadband",
        "cause": "disturbance",
        "source": "gui",
        "service": null,
        "state": "open",
        "start_date": "2017-06-29T12:29:06Z",
        "end_date": "2017-06-29T09:27:05Z",
        "region": "Woerden",
        "description": null,
        "long_description": "<p>Auto-generated long_description field for geographical-broadband. This is an geographical failure. testing123</p>",
        "serviceguard_ticket_id": "gtgyyg",
        "created_at": "2017-06-29T12:29:06Z",
        "communication_type": null,
        "user": null
    },
    ...
    ...
    ...
]


Return codes

Code Description
200 Success.
201 Created.
202 Accepted.
302 Found. Link in location header.
400 Bad request.
401 Unauthorized.
403 Forbidden.
404 Not found.
405 Method not allowed.
412 Precondition failed.
429 Too many requests.
500 Internal server error.
502 Bad gateway.
503 Service unavailable.

Mopinion feedback