Introduction
To get service health profile of a service, you must submit a service health request.
Request Lifecycle
Service health of a service can be done, as follows:
-
Create a service-health-request resource, by sending a POST request to
/api/connect/services/health/requestwith the body of the request containing the service id. The response’s http status will be 201 with a blank response body. There will be a Location response header with a URL. This URL is where the request outcome can be obtained. -
Make a
GETrequest to the URL returned in 1. to retrieve the outcome of the request. While the request is in progress, the response’shttp statuswill be202. This means that the request has not finished yet, but will in a moment. If the request was successful a service-heath-request resource will be returned. If the request failed a422will be returned with the body containing details on why it failed in the standard error format.
Please note that the service health process itself may take a while to complete.
Request Specifications
| Version | Header | Changes |
|---|---|---|
5 |
X-API-VERSION=5 |
Initial Version |
6 |
X-API-VERSION=6 |
Conform to endpoints standards(Get endpoint). Updated get response. |
7 |
X-API-VERSION=7 |
No Change |
API Version 6 and 7
POST Request
Verb |
POST |
URI |
/api/connect/services/health/request |
| Name | Description |
|---|---|
|
The OAuth bearer access token |
|
The version of the endpoint you are accessing |
| Path | Type | Description | Required |
|---|---|---|---|
|
|
The id of the service. |
Required |
POST Response
| Status Code | Meaning |
|---|---|
201 |
The request was created successfully |
401 |
Bearer token is missing or invalid |
404 |
You do not have permission to perform this task |
422 |
There are validation errors on the request you made. Check the response body to see what fields had issues. |
500 |
There was an unexpected error processing the request |
GET Request
|
Note
|
The URI will be given to you in the Location header of the POST request. |
Verb |
GET |
URI |
/api/connect/services/health/requests/{id} |
Path Variable |
Purpose |
|
The id of the service health request |
| Name | Description |
|---|---|
|
The OAuth bearer access token |
|
The version of the endpoint you are accessing |
GET Response
| Status Code | Meaning |
|---|---|
200 |
The request is complete. The body contains the service-health resource |
202 |
The request is in progress |
401 |
Bearer token is missing or invalid |
404 |
You do not have permission to perform this task |
404 |
The id (of the service-health-request resource) provided does not exist |
422 |
The service-health resource failed to be created. Check the response body to see why |
500 |
There was an unexpected error processing the request |
| Path | Type | Description |
|---|---|---|
|
|
The Connect identifier of the service-health-request resource. |
|
|
The Connect identifier of the user who requested the service health. |
|
|
The date/time, including UTC offset, when service health request was made. |
|
|
The date/time, including UTC offset, when service health request was last refreshed. |
|
|
OPEN | IN_PROGRESS | COMPLETED | IN_ERROR | IN_ERROR_RETRY | FAILED |
|
|
The nbn unique ID of the service. |
|
|
The type of nbn technology that the service is delivered through. |
|
|
The name of the service plan. |
|
|
The nbn LOC ID of the address of the site the order is for. |
|
|
The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site. |
|
|
The Product Instance ID of the service. |
|
|
The Health Record ID of the service. |
|
|
Error details. If any |
|
|
The Current Condition of the service. |
|
|
The Code of the current condition. |
|
|
The Status of the current condition. |
|
|
The Alert Message of the current condition. |
|
|
The Summary of the current condition. |
|
|
The Next Action to be taken for the service. |
|
|
The Code of the next action. |
|
|
The Description of the next action. |
|
|
The health indicator of the service. |
|
|
The status of the connectivity health indicator. |
|
|
The status of the performance health indicator. |
|
|
The status of the stability health indicator. |
|
|
The health Categories of the service. |
|
|
The Type of the health category |
|
|
The Items of the health category |
|
|
The type of the item |
|
|
The id of the item |
|
|
The status of the item |
|
|
The unit of the item |
|
|
The value of the item |
API Version 6 - Examples
Successful Request
A service-health-request resource is created by sending a POST request to
/api/connect/services/health/request.
POST Request
POST /api/connect/services/health/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 24
Host: 360-api.superloop.com
{
"serviceId" : 1200
}If a valid service id was provided, then the response to the request will have:
-
a http status of 201
Successful POST Response
HTTP/1.1 201 Created
Location: /api/connect/services/health/requests/13
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| Name | Description |
|---|---|
|
The URL from where the outcome of the request can be obtained. Poll this URL until the request is complete |
Once you have the URI from the Location header, poll that URI every so often by making a GET request. While service
health is in progress, the GET request’s response will have a http status of 202. Keep polling the
URL until it finishes, once the request is completed successfully the GET request’s response will have a http
status of 200 and the serviceStatus will be COMPLETED
|
Note
|
Please keep the polling to a sensible rate. |
GET Request
GET /api/connect/services/health/requests/13 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comSuccessful Response
Successful GET Response service health request in open
HTTP/1.1 202 Accepted
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: DENYSuccessful GET Response service health request in progress
HTTP/1.1 202 Accepted
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: DENYFTTP
Successful GET Response service health request completed
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: 5970
{
"id" : 6,
"requestedById" : 11000,
"requestedOn" : "2020-07-01T04:32:58Z",
"lastRefreshedOn" : "2022-06-09T09:00:55Z",
"status" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTP",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : null,
"currentCondition" : {
"code" : "OTH60001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn parameters."
},
"nextAction" : {
"code" : "NBA60001",
"description" : "If your customer is still experiencing an issue, obtain your customer's modem MAC address and NTD (Network Termination Device) Serial number and check it matches your internal systems and the details recorded in the Service Health Summary. If the details match, please troubleshoot the customer's equipment configuration. If the details do not match, please raise a service request to nbn to investigate a possible addressing issue. Include the details of the different MAC address and NTD Serial number in the trouble ticket."
},
"indicator" : {
"connectivity" : "Green",
"performance" : "Green",
"stability" : "Green"
},
"healthCategories" : [ {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "NTD",
"items" : [ {
"type" : "NTDMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "NTDMain",
"id" : "currentSpeedAndDuplex",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Data",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
}, {
"type" : "Data",
"id" : "portState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "NTDMain",
"id" : "serialNumber",
"status" : null,
"unit" : null,
"value" : "ALCLF8593E75"
}, {
"type" : "NTDMain",
"id" : "ntdId",
"status" : null,
"unit" : null,
"value" : "NTD000038042851"
}, {
"type" : "NTDMain",
"id" : "installLocation",
"status" : null,
"unit" : null,
"value" : "Indoor"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "lastChangeReason",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "OpMain",
"id" : "lastStatusChange",
"status" : null,
"unit" : null,
"value" : "2021-11-29T16:21:47Z"
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "OpticalSignal",
"items" : [ {
"type" : "OptMain",
"id" : "status",
"status" : "Green",
"unit" : null,
"value" : "No Issue Detected"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "A4:91:B1:28:08:06"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Grey",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
} ]
} ]
}FTTN
Successful GET Response service health request completed
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: 8670
{
"id" : 7,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:00:55Z",
"status" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTN",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "OTH10001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn specifications."
},
"nextAction" : {
"code" : "NBA10001",
"description" : "If your customer is experiencing a connectivity issue, execute the Refresh button on the Health Summary for the latest status and suggested action. If no change has occurred to the Health Summary result, complete standard pre-checks with your customer before raising a service restoration trouble ticket to nbn to investigate."
},
"indicator" : {
"connectivity" : "Green",
"performance" : "Green",
"stability" : "Green"
},
"healthCategories" : [ {
"type" : "InHomeWiring",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "inHomeWiring",
"status" : "Grey",
"unit" : null,
"value" : "Inconclusive"
} ]
}, {
"type" : "DynamicLineManagement",
"items" : [ {
"type" : "ScheduledAction",
"id" : "downstream",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "ScheduledAction",
"id" : "upstream",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "InHomeWiringMain",
"id" : "state",
"status" : "Grey",
"unit" : null,
"value" : null
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEHistory",
"id" : "replaceCount",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "CPEMain",
"id" : "registration",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "CPEMain",
"id" : "model",
"status" : null,
"unit" : null,
"value" : "NF18ACV"
}, {
"type" : "CPEMain",
"id" : "compatibility",
"status" : "Green",
"unit" : null,
"value" : null
}, {
"type" : "CPEMain",
"id" : "firmwareVersion",
"status" : null,
"unit" : null,
"value" : "41327076364630333976000000000000"
}, {
"type" : "CPEMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : "NetComm"
}, {
"type" : "CPEMain",
"id" : "serialNo",
"status" : null,
"unit" : null,
"value" : "NetComm NF18ACV"
}, {
"type" : "CPEHistory",
"id" : "period",
"status" : null,
"unit" : "Days",
"value" : "30"
}, {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "F8:CA:59:1E:5C:15"
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "Downstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "57.2"
}, {
"type" : "Upstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "24.8"
}, {
"type" : "Downstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "51.1"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "59.1"
}, {
"type" : "Upstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "21.1"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "24.4"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "24.4"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "58.9"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "24.4"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "58.9"
} ]
}, {
"type" : "SeamlessRateAdaptation",
"items" : [ {
"type" : "Downstream",
"id" : "mode",
"status" : "Grey",
"unit" : null,
"value" : null
}, {
"type" : "Upstream",
"id" : "mode",
"status" : "Grey",
"unit" : null,
"value" : null
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "OpMain",
"id" : "lineStatusChange",
"status" : null,
"unit" : null,
"value" : null
} ]
} ]
}FTTC
Successful GET Response service health request completed
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: 5756
{
"id" : 8,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:21:04Z",
"status" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTC",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "OTH30001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn parameters."
},
"nextAction" : {
"code" : "NBA30001",
"description" : "A service restoration trouble ticket should not be raised for this service at this time as it will most likely result in No Fault Found."
},
"indicator" : {
"connectivity" : "Green",
"performance" : "Green",
"stability" : "Green"
},
"healthCategories" : [ {
"type" : "Dropouts",
"items" : [ {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "macAddress",
"status" : "Grey",
"unit" : null,
"value" : "20:E8:82:EE:CC:FC"
} ]
}, {
"type" : "Ncd",
"items" : [ {
"type" : "NCDMain",
"id" : "portState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "NCDMain",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
}, {
"type" : "NCDMain",
"id" : "currentSpeedAndDuplex",
"status" : null,
"unit" : null,
"value" : "1000/Full"
}, {
"type" : "NCDMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "F8:CA:59:27:3A:A5"
}, {
"type" : "NCDMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "Upstream",
"id" : "actualLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "44.3"
}, {
"type" : "Upstream",
"id" : "assuredLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "20.5"
}, {
"type" : "Downstream",
"id" : "actualLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "109"
}, {
"type" : "Upstream",
"id" : "actualLineRate7Days",
"status" : "Grey",
"unit" : "Mbps",
"value" : "44.3"
}, {
"type" : "Downstream",
"id" : "assuredLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "51.3"
}, {
"type" : "Downstream",
"id" : "actualLineRate7Days",
"status" : "Grey",
"unit" : "Mbps",
"value" : "108.9"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "reversePowerState",
"status" : null,
"unit" : null,
"value" : "Powered"
}, {
"type" : "OpMain",
"id" : "lastStatusChange",
"status" : null,
"unit" : null,
"value" : "2022-06-04T18:11:28Z"
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "InHomeWiring",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "inHomeWiring",
"status" : "Green",
"unit" : null,
"value" : "No Bridge Tap Detected"
}, {
"type" : "InHomeWiringMain",
"id" : "lineImpairments",
"status" : "Green",
"unit" : null,
"value" : "No Issue Detected"
} ]
} ]
}FTTB
Successful GET Response service health request completed
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: 8835
{
"id" : 9,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:31:28Z",
"status" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTB",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "OTH10001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn specifications."
},
"nextAction" : {
"code" : "NBA10001",
"description" : "If your customer is still experiencing an issue, obtain your customer's modem MAC address and check it matches your internal systems and the details recorded in the Service Health Summary. If details match, please troubleshoot the customer's equipment configuration. If the details do not match, please raise a service loss trouble ticket to nbn to investigate a possible jumpering issue. Include the details of the different MAC address in the trouble ticket."
},
"indicator" : {
"connectivity" : "Green",
"performance" : "Green",
"stability" : "Green"
},
"healthCategories" : [ {
"type" : "SeamlessRateAdaptation",
"items" : [ {
"type" : "Downstream",
"id" : "mode",
"status" : "Green",
"unit" : null,
"value" : "Dynamic"
}, {
"type" : "Upstream",
"id" : "mode",
"status" : "Green",
"unit" : null,
"value" : "Dynamic"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "lineStatusChange",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "DynamicLineManagement",
"items" : [ {
"type" : "ScheduledAction",
"id" : "upstream",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "InHomeWiringMain",
"id" : "state",
"status" : "Grey",
"unit" : null,
"value" : null
}, {
"type" : "ScheduledAction",
"id" : "downstream",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "Downstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "107.7"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "143.0"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "50.4"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "50.4"
}, {
"type" : "Downstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "26.1"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "143.2"
}, {
"type" : "Upstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "5.1"
}, {
"type" : "Upstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "44.2"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "143.1"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "50.4"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEHistory",
"id" : "replaceCount",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "CPEMain",
"id" : "compatibility",
"status" : "Green",
"unit" : null,
"value" : null
}, {
"type" : "CPEMain",
"id" : "firmwareVersion",
"status" : null,
"unit" : null,
"value" : "41327076364630333976000000000000"
}, {
"type" : "CPEMain",
"id" : "registration",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "CPEHistory",
"id" : "period",
"status" : null,
"unit" : "Days",
"value" : "30"
}, {
"type" : "CPEMain",
"id" : "serialNo",
"status" : null,
"unit" : null,
"value" : "NetComm NL19ACV"
}, {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "F8:CA:59:71:50:C5"
}, {
"type" : "CPEMain",
"id" : "model",
"status" : null,
"unit" : null,
"value" : "NL19ACV"
}, {
"type" : "CPEMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : "NetComm"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "Do30Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "2095663"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "3"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "1"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "1"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "127517"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "3"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "InHomeWiring",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "inHomeWiring",
"status" : "Grey",
"unit" : null,
"value" : "No Issue Detected"
} ]
} ]
}HFC
Successful GET Response service health request completed
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: 5893
{
"id" : 10,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:36:54Z",
"status" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "HFC",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "PER20001",
"status" : "Red",
"alertMessage" : "Potential Performance issue - HFC Signal is not within specifications",
"summary" : "HFC Signal is not within specifications, and may cause an issue with service performance."
},
"nextAction" : {
"code" : "NBA20301",
"description" : "Checking the cables from the wall outlet to the NTD (Network Termination Device) are connected tightly and without unused splitters could resolve the issue.Please ensure that your customer's modem is switched on and connected correctly. A service restoration trouble ticket can be raised to nbn, but may result in a No Fault Found."
},
"indicator" : {
"connectivity" : "Green",
"performance" : "Amber",
"stability" : "Green"
},
"healthCategories" : [ {
"type" : "Dropouts",
"items" : [ {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoMain",
"id" : "timeOfLastDropout",
"status" : null,
"unit" : null,
"value" : "2022-05-16T18:08:43Z"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "4"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "1"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "5"
}, {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "NTD",
"items" : [ {
"type" : "NTDMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "78:23:AE:8E:BD:19"
}, {
"type" : "NTDMain",
"id" : "portState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "NTDMain",
"id" : "model",
"status" : "Green",
"unit" : null,
"value" : "CM8200B"
}, {
"type" : "NTDMain",
"id" : "serviceConfiguration",
"status" : "Green",
"unit" : null,
"value" : "Aligned"
}, {
"type" : "NTDMain",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "HFCSignalMain",
"id" : "status",
"status" : "Amber",
"unit" : null,
"value" : "Issue Detected"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "70:3A:CB:93:21:55"
}, {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "8A:23:AE:8E:BD:19"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "lastStatusChange",
"status" : null,
"unit" : null,
"value" : "2022-05-28T18:11:10Z"
}, {
"type" : "OpMain",
"id" : "uptime",
"status" : null,
"unit" : "Seconds",
"value" : "1340925"
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
} ]
}Fixed Wireless
Successful GET Response service health request completed
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: 2824
{
"id" : 11,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:36:54Z",
"status" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "Fixed Wireless",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "PER40018",
"status" : "Amber",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn parameters."
},
"nextAction" : {
"code" : "NBA40318",
"description" : "If your customer is still experiencing an issue, reboot the customers' equipment and the Network Termination Device (NTD). If no change has occurred to the service after troubleshooting, a service restoration trouble ticket can be raised to nbn, but may result in a No Fault Found."
},
"indicator" : {
"connectivity" : "Green",
"performance" : "Green",
"stability" : "Grey"
},
"healthCategories" : [ {
"type" : "NTD",
"items" : [ {
"type" : "NTDMain",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
}, {
"type" : "NTDMain",
"id" : "ntdVersion",
"status" : null,
"unit" : null,
"value" : "V3"
}, {
"type" : "NTDMain",
"id" : "ntdId",
"status" : null,
"unit" : null,
"value" : "NTD000048485162"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "Network",
"items" : [ {
"type" : "Backhaul",
"id" : "plannedActivity",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Backhaul",
"id" : "forecastUpgradeDate",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Cell",
"id" : "plannedActivity",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Cell",
"id" : "forecastUpgradeDate",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Cell",
"id" : "busyHourPerformance",
"status" : "Green",
"unit" : null,
"value" : "6 Mbps and above"
}, {
"type" : "Backhaul",
"id" : "busyHourPerformance",
"status" : "Green",
"unit" : null,
"value" : "Link is not experiencing network congestion"
} ]
} ]
}Successful GET Response service health request in error
HTTP/1.1 422 Unprocessable Entity
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: 385
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.service.health.request.in.error",
"message" : "Error encountered",
"object" : "ServiceHealth",
"field" : "status",
"rejectedValue" : "IN_ERROR"
} ],
"timestamp" : "2025-03-11T22:24:30.549606604Z"
}Successful GET Response service health request failed
HTTP/1.1 422 Unprocessable Entity
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: 394
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.service.health.request.in.error",
"message" : "An unexpected error occurred.",
"object" : "ServiceHealth",
"field" : "status",
"rejectedValue" : "FAILED"
} ],
"timestamp" : "2025-03-11T22:24:36.28342086Z"
}Invalid Request
If the request is invalid for any reason, a http status of 422 is returned and the body of the
response will list the problems with the request.
This example is of submitting a request when there is already a service health request in progress for the service.
POST Request - Service Health Request
POST /api/connect/services/health/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 24
Host: 360-api.superloop.com
{
"serviceId" : 1600
}POST Response with request validation errors
HTTP/1.1 422 Unprocessable Entity
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: 457
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.service.health.request.in.progress",
"message" : "Service with id 1600 already has a health request in progress",
"object" : "RequestNbnServiceHealthCommand",
"field" : "ServiceHealthRequest",
"rejectedValue" : 1600
} ],
"timestamp" : "2025-03-11T22:24:31.660524231Z"
}Bad Request
GET Request bad request
GET /api/connect/services/health/requests/AAA HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comGET 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:24:32.800633398Z"
}API Version 5
POST Request
Verb |
POST |
URI |
/api/connect/services/health/request |
| Name | Description |
|---|---|
|
The OAuth bearer access token |
|
The version of the endpoint you are accessing |
| Path | Type | Description | Required |
|---|---|---|---|
|
|
The id of the service. |
Required |
POST Response
| Status Code | Meaning |
|---|---|
201 |
The request was created successfully |
401 |
Bearer token is missing or invalid |
404 |
You do not have permission to perform this task |
422 |
There are validation errors on the request you made. Check the response body to see what fields had issues. |
500 |
There was an unexpected error processing the request |
GET Request
|
Note
|
The URI will be given to you in the Location header of the POST request. |
Verb |
GET |
URI |
/api/connect/services/health/request/{id} |
Path Variable |
Purpose |
|
The id of the service health request |
| Name | Description |
|---|---|
|
The OAuth bearer access token |
|
The version of the endpoint you are accessing |
GET Response
| Status Code | Meaning |
|---|---|
200 |
The request is complete. The body contains the service-health resource |
202 |
The request is in progress |
401 |
Bearer token is missing or invalid |
404 |
You do not have permission to perform this task |
404 |
The id (of the service-health-request resource) provided does not exist |
422 |
The service-health resource failed to be created. Check the response body to see why |
500 |
There was an unexpected error processing the request |
| Path | Type | Description |
|---|---|---|
|
|
The Connect identifier of the service-health-request resource. |
|
|
The Connect identifier of the user who requested the service health. |
|
|
The date/time, including UTC offset, when service health request was made. |
|
|
The date/time, including UTC offset, when service health request was last refreshed. |
|
|
OPEN | IN_PROGRESS | COMPLETED | IN_ERROR | IN_ERROR_RETRY | FAILED |
|
|
The nbn unique ID of the service. |
|
|
The type of nbn technology that the service is delivered through. |
|
|
The name of the service plan. |
|
|
The nbn LOC ID of the address of the site the order is for. |
|
|
The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site. |
|
|
The Product Instance ID of the service. |
|
|
The Health Record ID of the service. |
|
|
Error details. If any |
|
|
The Current Condition of the service. |
|
|
The Code of the current condition. |
|
|
The Status of the current condition. |
|
|
The Alert Message of the current condition. |
|
|
The Summary of the current condition. |
|
|
The Next Action to be taken for the service. |
|
|
The Code of the next action. |
|
|
The Description of the next action. |
|
|
The health Indicators of the service. |
|
|
The status of the connectivity health indicator. |
|
|
The status of the performance health indicator. |
|
|
The status of the stability health indicator. |
|
|
The health Category of the service. |
|
|
The Type of the health category |
|
|
The Items of the health category |
|
|
The type of the item |
|
|
The id of the item |
|
|
The status of the item |
|
|
The unit of the item |
|
|
The value of the item |
API Version 5 - Examples
Successful Request
A service-health-request resource is created by sending a POST request to
/api/connect/services/health/request.
POST Request
POST /api/connect/services/health/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 5
Content-Length: 24
Host: 360-api.superloop.com
{
"serviceId" : 1200
}If a valid service id was provided, then the response to the request will have:
-
a http status of 201
Successful POST Response
HTTP/1.1 201 Created
Location: /api/connect/services/health/request/13
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| Name | Description |
|---|---|
|
The URL from where the outcome of the request can be obtained. Poll this URL until the request is complete |
Once you have the URI from the Location header, poll that URI every so often by making a GET request. While service
health is in progress, the GET request’s response will have a http status of 202. Keep polling the
URL until it finishes, once the request is completed successfully the GET request’s response will have a http
status of 200 and the serviceStatus will be COMPLETED
|
Note
|
Please keep the polling to a sensible rate. |
GET Request
GET /api/connect/services/health/request/13 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 5
Host: 360-api.superloop.comSuccessful Response
Successful GET Response service health request in open
HTTP/1.1 202 Accepted
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: 498
{
"id" : 13,
"requestedById" : 11001,
"requestedOn" : "2025-03-11T22:24:17Z",
"lastRefreshedOn" : "2025-03-11T22:24:17Z",
"serviceStatus" : "OPEN",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : null,
"plan" : null,
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : null,
"errorDetail" : null,
"currentCondition" : null,
"nextAction" : null,
"indicators" : null,
"healthCategory" : null
}Successful GET Response service health request in progress
HTTP/1.1 202 Accepted
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: 505
{
"id" : 13,
"requestedById" : 11001,
"requestedOn" : "2025-03-11T22:24:17Z",
"lastRefreshedOn" : "2025-03-11T22:24:17Z",
"serviceStatus" : "IN_PROGRESS",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : null,
"plan" : null,
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : null,
"errorDetail" : null,
"currentCondition" : null,
"nextAction" : null,
"indicators" : null,
"healthCategory" : null
}FTTP
Successful GET Response service health request completed
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: 6003
{
"id" : 6,
"requestedById" : 11000,
"requestedOn" : "2020-07-01T04:32:58Z",
"lastRefreshedOn" : "2022-06-09T09:00:55Z",
"serviceStatus" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTP",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : null,
"currentCondition" : {
"code" : "OTH60001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn parameters."
},
"nextAction" : {
"code" : "NBA60001",
"description" : "If your customer is still experiencing an issue, obtain your customer's modem MAC address and NTD (Network Termination Device) Serial number and check it matches your internal systems and the details recorded in the Service Health Summary. If the details match, please troubleshoot the customer's equipment configuration. If the details do not match, please raise a service request to nbn to investigate a possible addressing issue. Include the details of the different MAC address and NTD Serial number in the trouble ticket."
},
"indicators" : {
"connectivityIndicator" : "Green",
"performanceIndicator" : "Green",
"stabilityIndicator" : "Green"
},
"healthCategory" : [ {
"type" : "Dropouts",
"items" : [ {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Grey",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "A4:91:B1:28:08:06"
} ]
}, {
"type" : "NTD",
"items" : [ {
"type" : "NTDMain",
"id" : "currentSpeedAndDuplex",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "NTDMain",
"id" : "installLocation",
"status" : null,
"unit" : null,
"value" : "Indoor"
}, {
"type" : "NTDMain",
"id" : "ntdId",
"status" : null,
"unit" : null,
"value" : "NTD000038042851"
}, {
"type" : "NTDMain",
"id" : "serialNumber",
"status" : null,
"unit" : null,
"value" : "ALCLF8593E75"
}, {
"type" : "Data",
"id" : "portState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "NTDMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Data",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
} ]
}, {
"type" : "OpticalSignal",
"items" : [ {
"type" : "OptMain",
"id" : "status",
"status" : "Green",
"unit" : null,
"value" : "No Issue Detected"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "lastChangeReason",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "OpMain",
"id" : "lastStatusChange",
"status" : null,
"unit" : null,
"value" : "2021-11-29T16:21:47Z"
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
} ]
}FTTN
Successful GET Response service health request completed
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: 8703
{
"id" : 7,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:00:55Z",
"serviceStatus" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTN",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "OTH10001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn specifications."
},
"nextAction" : {
"code" : "NBA10001",
"description" : "If your customer is experiencing a connectivity issue, execute the Refresh button on the Health Summary for the latest status and suggested action. If no change has occurred to the Health Summary result, complete standard pre-checks with your customer before raising a service restoration trouble ticket to nbn to investigate."
},
"indicators" : {
"connectivityIndicator" : "Green",
"performanceIndicator" : "Green",
"stabilityIndicator" : "Green"
},
"healthCategory" : [ {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "firmwareVersion",
"status" : null,
"unit" : null,
"value" : "41327076364630333976000000000000"
}, {
"type" : "CPEMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : "NetComm"
}, {
"type" : "CPEHistory",
"id" : "period",
"status" : null,
"unit" : "Days",
"value" : "30"
}, {
"type" : "CPEMain",
"id" : "model",
"status" : null,
"unit" : null,
"value" : "NF18ACV"
}, {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "F8:CA:59:1E:5C:15"
}, {
"type" : "CPEHistory",
"id" : "replaceCount",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "CPEMain",
"id" : "serialNo",
"status" : null,
"unit" : null,
"value" : "NetComm NF18ACV"
}, {
"type" : "CPEMain",
"id" : "compatibility",
"status" : "Green",
"unit" : null,
"value" : null
}, {
"type" : "CPEMain",
"id" : "registration",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "SeamlessRateAdaptation",
"items" : [ {
"type" : "Downstream",
"id" : "mode",
"status" : "Grey",
"unit" : null,
"value" : null
}, {
"type" : "Upstream",
"id" : "mode",
"status" : "Grey",
"unit" : null,
"value" : null
} ]
}, {
"type" : "DynamicLineManagement",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "state",
"status" : "Grey",
"unit" : null,
"value" : null
}, {
"type" : "ScheduledAction",
"id" : "upstream",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "ScheduledAction",
"id" : "downstream",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "Downstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "58.9"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "24.4"
}, {
"type" : "Upstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "24.8"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "24.4"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "24.4"
}, {
"type" : "Upstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "21.1"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "59.1"
}, {
"type" : "Downstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "57.2"
}, {
"type" : "Downstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "51.1"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "58.9"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "lineStatusChange",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "InHomeWiring",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "inHomeWiring",
"status" : "Grey",
"unit" : null,
"value" : "Inconclusive"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
} ]
} ]
}FTTC
Successful GET Response service health request completed
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: 5789
{
"id" : 8,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:21:04Z",
"serviceStatus" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTC",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "OTH30001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn parameters."
},
"nextAction" : {
"code" : "NBA30001",
"description" : "A service restoration trouble ticket should not be raised for this service at this time as it will most likely result in No Fault Found."
},
"indicators" : {
"connectivityIndicator" : "Green",
"performanceIndicator" : "Green",
"stabilityIndicator" : "Green"
},
"healthCategory" : [ {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "macAddress",
"status" : "Grey",
"unit" : null,
"value" : "20:E8:82:EE:CC:FC"
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "Downstream",
"id" : "actualLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "109"
}, {
"type" : "Upstream",
"id" : "assuredLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "20.5"
}, {
"type" : "Upstream",
"id" : "actualLineRate7Days",
"status" : "Grey",
"unit" : "Mbps",
"value" : "44.3"
}, {
"type" : "Downstream",
"id" : "actualLineRate7Days",
"status" : "Grey",
"unit" : "Mbps",
"value" : "108.9"
}, {
"type" : "Upstream",
"id" : "actualLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "44.3"
}, {
"type" : "Downstream",
"id" : "assuredLineRate",
"status" : "Grey",
"unit" : "Mbps",
"value" : "51.3"
} ]
}, {
"type" : "Ncd",
"items" : [ {
"type" : "NCDMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "NCDMain",
"id" : "portState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "NCDMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "F8:CA:59:27:3A:A5"
}, {
"type" : "NCDMain",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
}, {
"type" : "NCDMain",
"id" : "currentSpeedAndDuplex",
"status" : null,
"unit" : null,
"value" : "1000/Full"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "InHomeWiring",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "inHomeWiring",
"status" : "Green",
"unit" : null,
"value" : "No Bridge Tap Detected"
}, {
"type" : "InHomeWiringMain",
"id" : "lineImpairments",
"status" : "Green",
"unit" : null,
"value" : "No Issue Detected"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "OpMain",
"id" : "reversePowerState",
"status" : null,
"unit" : null,
"value" : "Powered"
}, {
"type" : "OpMain",
"id" : "lastStatusChange",
"status" : null,
"unit" : null,
"value" : "2022-06-04T18:11:28Z"
} ]
} ]
}FTTB
Successful GET Response service health request completed
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: 8868
{
"id" : 9,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:31:28Z",
"serviceStatus" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "FTTB",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "OTH10001",
"status" : "Green",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn specifications."
},
"nextAction" : {
"code" : "NBA10001",
"description" : "If your customer is still experiencing an issue, obtain your customer's modem MAC address and check it matches your internal systems and the details recorded in the Service Health Summary. If details match, please troubleshoot the customer's equipment configuration. If the details do not match, please raise a service loss trouble ticket to nbn to investigate a possible jumpering issue. Include the details of the different MAC address in the trouble ticket."
},
"indicators" : {
"connectivityIndicator" : "Green",
"performanceIndicator" : "Green",
"stabilityIndicator" : "Green"
},
"healthCategory" : [ {
"type" : "Speed",
"items" : [ {
"type" : "Downstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "26.1"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "50.4"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "50.4"
}, {
"type" : "Upstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "50.4"
}, {
"type" : "Upstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "44.2"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "143.0"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate2Hrs",
"status" : null,
"unit" : "Mbps",
"value" : "143.1"
}, {
"type" : "Downstream",
"id" : "AttainableLineRate7Days",
"status" : null,
"unit" : "Mbps",
"value" : "143.2"
}, {
"type" : "Downstream",
"id" : "ActualLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "107.7"
}, {
"type" : "Upstream",
"id" : "AssuredLineRate",
"status" : null,
"unit" : "Mbps",
"value" : "5.1"
} ]
}, {
"type" : "DynamicLineManagement",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "state",
"status" : "Grey",
"unit" : null,
"value" : null
}, {
"type" : "ScheduledAction",
"id" : "upstream",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "ScheduledAction",
"id" : "downstream",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "SeamlessRateAdaptation",
"items" : [ {
"type" : "Upstream",
"id" : "mode",
"status" : "Green",
"unit" : null,
"value" : "Dynamic"
}, {
"type" : "Downstream",
"id" : "mode",
"status" : "Green",
"unit" : null,
"value" : "Dynamic"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "3"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "1"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "127517"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "2095663"
}, {
"type" : "Do2Days",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "1"
}, {
"type" : "DoToday",
"id" : "unavailablePeriod",
"status" : null,
"unit" : "Seconds",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "3"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "OpMain",
"id" : "lineStatusChange",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "serialNo",
"status" : null,
"unit" : null,
"value" : "NetComm NL19ACV"
}, {
"type" : "CPEMain",
"id" : "compatibility",
"status" : "Green",
"unit" : null,
"value" : null
}, {
"type" : "CPEMain",
"id" : "firmwareVersion",
"status" : null,
"unit" : null,
"value" : "41327076364630333976000000000000"
}, {
"type" : "CPEHistory",
"id" : "replaceCount",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "CPEMain",
"id" : "model",
"status" : null,
"unit" : null,
"value" : "NL19ACV"
}, {
"type" : "CPEMain",
"id" : "registration",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "CPEMain",
"id" : "make",
"status" : null,
"unit" : null,
"value" : "NetComm"
}, {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "F8:CA:59:71:50:C5"
}, {
"type" : "CPEHistory",
"id" : "period",
"status" : null,
"unit" : "Days",
"value" : "30"
} ]
}, {
"type" : "InHomeWiring",
"items" : [ {
"type" : "InHomeWiringMain",
"id" : "inHomeWiring",
"status" : "Grey",
"unit" : null,
"value" : "No Issue Detected"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
} ]
}HFC
Successful GET Response service health request completed
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: 5926
{
"id" : 10,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:36:54Z",
"serviceStatus" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "HFC",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "PER20001",
"status" : "Red",
"alertMessage" : "Potential Performance issue - HFC Signal is not within specifications",
"summary" : "HFC Signal is not within specifications, and may cause an issue with service performance."
},
"nextAction" : {
"code" : "NBA20301",
"description" : "Checking the cables from the wall outlet to the NTD (Network Termination Device) are connected tightly and without unused splitters could resolve the issue.Please ensure that your customer's modem is switched on and connected correctly. A service restoration trouble ticket can be raised to nbn, but may result in a No Fault Found."
},
"indicators" : {
"connectivityIndicator" : "Green",
"performanceIndicator" : "Amber",
"stabilityIndicator" : "Green"
},
"healthCategory" : [ {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "uptime",
"status" : null,
"unit" : "Seconds",
"value" : "1340925"
}, {
"type" : "OpMain",
"id" : "lastStatusChange",
"status" : null,
"unit" : null,
"value" : "2022-05-28T18:11:10Z"
}, {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "Cpe",
"items" : [ {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "70:3A:CB:93:21:55"
}, {
"type" : "CPEMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "8A:23:AE:8E:BD:19"
} ]
}, {
"type" : "Speed",
"items" : [ {
"type" : "HFCSignalMain",
"id" : "status",
"status" : "Amber",
"unit" : null,
"value" : "Issue Detected"
} ]
}, {
"type" : "Dropouts",
"items" : [ {
"type" : "DoToday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "4"
}, {
"type" : "DoYesterday",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "5"
}, {
"type" : "DoMain",
"id" : "timeOfLastDropout",
"status" : null,
"unit" : null,
"value" : "2022-05-16T18:08:43Z"
}, {
"type" : "DoToday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "network",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "unexpected",
"status" : null,
"unit" : "Count",
"value" : "1"
}, {
"type" : "DoToday",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "network",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoToday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "total",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do2Days",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do7Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "Do30Days",
"id" : "initiated",
"status" : null,
"unit" : "Count",
"value" : "0"
}, {
"type" : "DoYesterday",
"id" : "unexpected",
"status" : "Green",
"unit" : "Count",
"value" : "0"
} ]
}, {
"type" : "NTD",
"items" : [ {
"type" : "NTDMain",
"id" : "portState",
"status" : "Green",
"unit" : null,
"value" : "Up"
}, {
"type" : "NTDMain",
"id" : "model",
"status" : "Green",
"unit" : null,
"value" : "CM8200B"
}, {
"type" : "NTDMain",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
}, {
"type" : "NTDMain",
"id" : "macAddress",
"status" : null,
"unit" : null,
"value" : "78:23:AE:8E:BD:19"
}, {
"type" : "NTDMain",
"id" : "serviceConfiguration",
"status" : "Green",
"unit" : null,
"value" : "Aligned"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
} ]
}Fixed Wireless
Successful GET Response service health request completed
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: 2857
{
"id" : 11,
"requestedById" : 1,
"requestedOn" : "2022-06-08T10:48:00Z",
"lastRefreshedOn" : "2022-06-09T09:36:54Z",
"serviceStatus" : "COMPLETED",
"nbnServiceId" : "1eb225c1-f6da-68f0-8822-b69f036222be",
"technologyType" : "Fixed Wireless",
"plan" : "Home Fast 25/5",
"locId" : "LOC000047046997",
"avcId" : "AVC000119460177",
"priId" : "PRI000000110002",
"hriId" : "HRI000000000001",
"errorDetail" : "",
"currentCondition" : {
"code" : "PER40018",
"status" : "Amber",
"alertMessage" : "No Fault Detected",
"summary" : "The service appears to be working within nbn parameters."
},
"nextAction" : {
"code" : "NBA40318",
"description" : "If your customer is still experiencing an issue, reboot the customers' equipment and the Network Termination Device (NTD). If no change has occurred to the service after troubleshooting, a service restoration trouble ticket can be raised to nbn, but may result in a No Fault Found."
},
"indicators" : {
"connectivityIndicator" : "Green",
"performanceIndicator" : "Green",
"stabilityIndicator" : "Grey"
},
"healthCategory" : [ {
"type" : "Network",
"items" : [ {
"type" : "Backhaul",
"id" : "busyHourPerformance",
"status" : "Green",
"unit" : null,
"value" : "Link is not experiencing network congestion"
}, {
"type" : "Cell",
"id" : "plannedActivity",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Cell",
"id" : "busyHourPerformance",
"status" : "Green",
"unit" : null,
"value" : "6 Mbps and above"
}, {
"type" : "Backhaul",
"id" : "plannedActivity",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Backhaul",
"id" : "forecastUpgradeDate",
"status" : null,
"unit" : null,
"value" : null
}, {
"type" : "Cell",
"id" : "forecastUpgradeDate",
"status" : null,
"unit" : null,
"value" : null
} ]
}, {
"type" : "NTD",
"items" : [ {
"type" : "NTDMain",
"id" : "ntdVersion",
"status" : null,
"unit" : null,
"value" : "V3"
}, {
"type" : "NTDMain",
"id" : "ntdId",
"status" : null,
"unit" : null,
"value" : "NTD000048485162"
}, {
"type" : "NTDMain",
"id" : "portId",
"status" : null,
"unit" : null,
"value" : "UNI-D1"
} ]
}, {
"type" : "OperationalStatus",
"items" : [ {
"type" : "OpMain",
"id" : "serviceState",
"status" : "Green",
"unit" : null,
"value" : "Up"
} ]
}, {
"type" : "Outage",
"items" : [ {
"type" : "OutageMain",
"id" : "currentOutage",
"status" : null,
"unit" : null,
"value" : "false"
} ]
} ]
}Successful GET Response service health request in error
HTTP/1.1 422 Unprocessable Entity
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: 385
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.service.health.request.in.error",
"message" : "Error encountered",
"object" : "ServiceHealth",
"field" : "status",
"rejectedValue" : "IN_ERROR"
} ],
"timestamp" : "2025-03-11T22:24:18.736520083Z"
}Successful GET Response service health request failed
HTTP/1.1 422 Unprocessable Entity
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: 394
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.service.health.request.in.error",
"message" : "An unexpected error occurred.",
"object" : "ServiceHealth",
"field" : "status",
"rejectedValue" : "FAILED"
} ],
"timestamp" : "2025-03-11T22:24:24.49384696Z"
}Invalid Request
If the request is invalid for any reason, a http status of 422 is returned and the body of the
response will list the problems with the request.
This example is of submitting a request when there is already a service health request in progress for the service.
POST Request - Service Health Request
POST /api/connect/services/health/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 5
Content-Length: 24
Host: 360-api.superloop.com
{
"serviceId" : 1600
}POST Response with request validation errors
HTTP/1.1 422 Unprocessable Entity
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: 457
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.service.health.request.in.progress",
"message" : "Service with id 1600 already has a health request in progress",
"object" : "RequestNbnServiceHealthCommand",
"field" : "ServiceHealthRequest",
"rejectedValue" : 1600
} ],
"timestamp" : "2025-03-11T22:24:19.932224004Z"
}Bad Request
GET Request bad request
GET /api/connect/services/health/request/AAA HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 5
Host: 360-api.superloop.comGET 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: 362
{
"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:24:21.05935122Z"
}