← Back to Location Coat

Introduction

To get Change of Access Technology (COAT) for a location, you must submit a location coat request.

Request Lifecycle

Location coat can be retrieved, as follows:

  1. Create a location-coat-request resource, by sending a POST request to /api/connect/locations/coats/request with the body of the request containing the location 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.

  2. Make a GET request to the URL returned in 1. to retrieve the outcome of the request. While the request is in progress, the response’s http status will be 202. This means that the request has not finished yet, but will in a moment. If the request was successful a location-coat-request resource will be returned. If the request failed a 422 will be returned with the body containing details on why it failed in the standard error format.

Please note that the location coat request process itself may take a while to complete.

Request Specifications

Table 1. API Versions
Version Header Changes

6

X-API-VERSION=6

Initial Version

7

X-API-VERSION=7

No Change

API Version 6 and 7

POST Request

Table 2. POST Request

Verb

POST

URI

/api/connect/locations/coats/request
Table 3. POST HTTP Request Headers
Name Description

Authorization

The OAuth bearer access token

X-API-VERSION

The version of the endpoint you are accessing
Table 4. POST Request Body Fields
Path Type Description Required

locationId

String

The nbn unique identifier of the location.

Required

POST Response

Table 5. POST HTTP Status Codes
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 the 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.
Table 6. GET Request

Verb

GET

URI

/api/connect/locations/coats/requests/{id}
Table 7. GET Request Path Variables

Path Variable

Purpose

id

The id of the location coat request
Table 8. 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 9. GET HTTP Status Codes
Status Code Meaning

200

The request is complete. The body contains the COAT information for the location id

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 location-coat-request resource) provided does not exist

422

There are validation errors on the request you made. Check the response body to see the issues

500

There was an unexpected error processing the request
Table 10. GET Response Body Fields
Path Type Description

locationId

String

The nbn unique identifier of the location.

formattedAddress

String

The whole address of the location.

currentTechnology

String

Current Primary Access Technology for the location.

plannedTechnology

String

The new Primary Access Technology that the location will move to.

reason

String

The reason for technology change.

earliestChangeoverDate

String

This is the earliest date when nbn plan to make the change to new technology. Format as yyyy-mm-dd.

latestChangeoverDate

Null

This is the latest date when nbn plan to make the change to new technology. Format as yyyy-mm-dd.

completedDate

Null

This is the date at which the old technology at the location will be decommissioned. Format as yyyy-mm-dd.

status

String

The status of the request

lastUpdatedAt

String

The date/time, including UTC offset, when location coat was last updated.

API Version 6 and 7 - Examples

Successful Request

A location-coat-request resource is created by sending a POST request to /api/connect/locations/coats/request.

POST Request
POST /api/connect/locations/coats/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 38
Host: 360-api.superloop.com

{
  "locationId" : "LOC000000000017"
}

If all required fields were provided, then the response to the request will have:

  1. a http status of 201

Successful POST Response
HTTP/1.1 201 Created
Location: /api/connect/locations/coats/requests/7
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

Once you have the URI from the Location header, poll that URI every so often by making a GET request. While location coat request 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 status will be COMPLETED

Note
 Please keep the polling to a sensible rate.
GET Request
GET /api/connect/locations/coats/requests/7 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.com
Successful GET Response location coat requested
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: DENY
Successful GET Response location coat 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: DENY
Successful GET Response location coat 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: 362

{
  "locationId" : "LOC000000000016",
  "formattedAddress" : "1 SMITH ST, PARALOWIE WA 5108",
  "currentTechnology" : "FTTB",
  "plannedTechnology" : "FTTP",
  "reason" : "on-demand-ready",
  "earliestChangeoverDate" : "2022-09-10",
  "latestChangeoverDate" : null,
  "completedDate" : null,
  "status" : "COMPLETED",
  "lastUpdatedAt" : "2022-09-16T04:39:25Z"
}
Successful GET Response location coat 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: 395

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.location.coat.request.in.error",
    "message" : "An unexpected error occurred.",
    "object" : "LocationCoat",
    "field" : "status",
    "rejectedValue" : "IN_ERROR"
  } ],
  "timestamp" : "2025-03-11T22:23:49.795741801Z"
}
Successful GET Response location coat 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: 387

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.location.coat.request.in.error",
    "message" : "LocationId is not valid",
    "object" : "LocationCoat",
    "field" : "status",
    "rejectedValue" : "FAILED"
  } ],
  "timestamp" : "2025-03-11T22:23:47.457595291Z"
}

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 where the location id is invalid.

GET Request
POST /api/connect/locations/coats/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 33
Host: 360-api.superloop.com

{
  "locationId" : "LOC0000012"
}
Successful GET Response
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: 433

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.location.id.not.valid",
    "message" : "LOC0000012 is not formatted correctly.Must be LOC followed by 12 digits",
    "object" : "Location ID",
    "field" : "locationId",
    "rejectedValue" : "LOC0000012"
  } ],
  "timestamp" : "2025-03-11T22:23:43.866008893Z"
}

Bad Request

GET Request bad request
GET /api/connect/locations/coats/requests/AAA HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
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:23:48.584435553Z"
}