← Back to Services

Introduction

  1. You can get paginated results of service disruptions by sending a GET request to /api/connect/services/{serviceId}/disruptions. Path variable serviceId is the connect identifier of the service you want to get the disruptions of.

  2. You can get filtered, paginated results by adding the query parameter status in the GET endpoint.

Status List

Status Description

ACTIVE

Currently active disruption on the service

SCHEDULED

Scheduled future disruption on the service

COMPLETED

Completed disruption on the service

Default values

Query Parameter Default Value

size

20

sort

maintenanceStartAt, DESC

Request Lifecycle

To get the paginated results of service disruptions, you must make a GET request to /api/connect/services/{serviceId}/disruptions. The response’s http status will be 200, with the paginated results in the response body.

Request Specifications

Table 1. API Versions
Version Header Changes

1 (Deprecated)

X-API-VERSION=1

Initial Version

2 (Deprecated)

X-API-VERSION=2

No change

3

X-API-VERSION=3

No change

4

X-API-VERSION=4

No change

5

X-API-VERSION=5

No change

6

X-API-VERSION=6

No Change

7

X-API-VERSION=7

No Change

API Version 1, 2, 3, 4, 5, 6 and 7

GET Request

Table 2. GET Request

Verb

GET

URI

/api/connect/services/{serviceId}/disruptions
Table 3. GET Request Path Variables

Path Variable

Purpose

serviceId

The id of the service resource
Table 4. GET HTTP Request Headers
Name Description

Authorization

The OAuth bearer access token

X-API-VERSION

The version of the endpoint you are accessing

GET Response

Table 5. GET HTTP Status Codes
Status Code Meaning

200

The body contains the paginated results of service disruptions

401

Bearer token is missing or invalid

400

The request was bad. Check the response body to see what the issue(s) are

404

You do not have permission to perform this task or the id of the service resource provided does not exist

500

There was an unexpected error retrieving the results
Table 6. GET Response Body Fields
Path Type Description

totalPages

Number

Total number of pages

currentPageSize

Number

Number of elements in the current page

totalElements

Number

Total number of elements

content

Array

List of disruptions for the service

content.[].type

String

Type of the disruption

content.[].maintenanceStartAt

String

The date/time, including UTC offset, NBN’s recorded start time

content.[].maintenanceEndAt

String

The date/time, including UTC offset, NBN’s recorded end time. This can be null value for disruption type = unscheduled

content.[].nbnDisruptionId

String

The NBN identifier of the disruption

content.[].description

String

Description of the disruption

content.[].severity

String

Severity of the disruption

content.[].category

String

Category of the disruption

content.[].status

String

Status of the disruption

size

Number

Page size

number

Number

Page number

sort

Array

List of sort objects

sort.[].direction

String

Enumeration value of sort direction

sort.[].property

String

Sorting property

sort.[].ignoreCase

Boolean

Whether or not sorting for this property is case insensitive

sort.[].nullHandling

String

Enumeration value of null handling hints that is used in sorting

sort.[].ascending

Boolean

Whether or not sorting for this property is ascending

sort.[].descending

Boolean

Whether or not sorting for this property is descending

lastPage

Boolean

Whether or not the current page is the last page

firstPage

Boolean

Whether or not the current page is the first page

API Version 1, 2, 3, 4, 5, 6 and 7 - Examples

Successful Request

The paginated results of service disruptions are returned by sending a GET request to /api/connect/services/{serviceId}/disruptions.

GET Request
GET /api/connect/services/1208/disruptions?status=ACTIVE&status=SCHEDULED&status=COMPLETED&page=0&size=20&sort=maintenanceStartAt%2CDESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 6
Host: 360-api.superloop.com
Successful GET Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1833

{
  "totalPages" : 1,
  "currentPageSize" : 4,
  "totalElements" : 4,
  "content" : [ {
    "type" : "scheduled",
    "maintenanceStartAt" : "2221-07-01T23:59:51Z",
    "maintenanceEndAt" : "2221-07-02T23:59:51Z",
    "nbnDisruptionId" : "CRQ000004222661",
    "description" : "This notification is to let you know that NBN will be performing network maintenance work.",
    "severity" : "Expedited",
    "category" : "Network",
    "status" : "SCHEDULED"
  }, {
    "type" : "scheduled",
    "maintenanceStartAt" : "2021-07-01T23:59:51Z",
    "maintenanceEndAt" : "2221-07-02T23:59:51Z",
    "nbnDisruptionId" : "CRQ000004222660",
    "description" : "This notification is to let you know that NBN will be performing network maintenance work.",
    "severity" : "Expedited",
    "category" : "Network",
    "status" : "ACTIVE"
  }, {
    "type" : "unscheduled",
    "maintenanceStartAt" : "2021-07-01T23:59:51Z",
    "maintenanceEndAt" : null,
    "nbnDisruptionId" : "CRQ000004222662",
    "description" : "This notification is to let you know that NBN will be performing network maintenance work.",
    "severity" : "Expedited",
    "category" : "Network",
    "status" : "ACTIVE"
  }, {
    "type" : "scheduled",
    "maintenanceStartAt" : "2021-07-01T23:59:51Z",
    "maintenanceEndAt" : "2021-07-02T23:59:51Z",
    "nbnDisruptionId" : "CRQ000004222663",
    "description" : "This notification is to let you know that NBN will be performing network maintenance work.",
    "severity" : "Expedited",
    "category" : "Network",
    "status" : "COMPLETED"
  } ],
  "size" : 20,
  "number" : 0,
  "sort" : [ {
    "direction" : "DESC",
    "property" : "maintenanceStartAt",
    "ignoreCase" : false,
    "nullHandling" : "NATIVE",
    "ascending" : false,
    "descending" : true
  } ],
  "firstPage" : true,
  "lastPage" : true
}
Bad Request
GET Request bad request
GET /api/connect/services/AAA/disruptions HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 6
Host: 360-api.superloop.com
GET Response bad request
HTTP/1.1 400 Bad Request
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 363

{
  "httpStatusCode" : 400,
  "type" : "client.validation",
  "code" : "method.argument.type.mismatch",
  "message" : "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Integer'; nested exception is java.lang.NumberFormatException: For input string: \"AAA\"",
  "apiSubErrors" : [ ],
  "timestamp" : "2025-03-11T22:28:07.341298414Z"
}