logo
API docs by Redocly

Network API (v1.0.1)

Download OpenAPI specification:Download

E-mail: api@tuatahifibre.co.nz

Activations

Grouping of activations related endpoints

Create ONT Activation (v1) Deprecated

Request an ONT activation

Authorizations:
OAuth
Request Body schema: application/json
required
orderId
required
string

Order identifier

technicianName
required
string

Name of the technican

ontSerialNumber
required
string

The ONT serial number

Responses

Request samples

Content type
application/json
{
  • "orderId": "ORD7816043",
  • "technicianName": "John Doe",
  • "ontSerialNumber": "4857544383F7C537"
}

Response samples

Content type
application/json
{
  • "activationId": "5d31f95a-b687-49b2-ac51-bcd780dec92c"
}

Create ONT Activation (v2)

Request an ONT activation

Authorizations:
OAuth
Request Body schema: application/json
required
orderId
required
string

Identifier of the order that this activation is being performed on behalf of

technicianName
required
string

Name of the technician who is performing the activation

required
object

Information regarding the ONT being activated

Responses

Request samples

Content type
application/json
{
  • "orderId": "ORD7816043",
  • "technicianName": "John Doe",
  • "ont": {
    }
}

Response samples

Content type
application/json
{
  • "activationId": "5d31f95a-b687-49b2-ac51-bcd780dec92c"
}

Get ONT Activation Result

Returns the activation result for a given activation id

Authorizations:
OAuth
path Parameters
activationId
required
string <uuid>

Unique ID of the activation

Responses

Response samples

Content type
application/json
{
  • "id": "fb40276b-04aa-4560-bf2b-02b38558d362",
  • "startTime": "2020-11-02T17:52:43.000+13:00",
  • "endTime": "2020-11-02T17:53:03.000+13:00",
  • "sysCreationDate": "2020-11-02T17:52:42.164+13:00",
  • "testStatus": "SUCCESS",
  • "type": "ontActivation",
  • "ontSerialNumber": "4857544383F7C537",
  • "productOwner": "Sample RSP",
  • "productId": "1636096814",
  • "result": {
    }
}

Diagnostics

Grouping of diagnostics related endpoints

Create Diagnostic Test

Request that a new test is performed. The caller must be authorised to read the PIID under test otherwise the request will be 404.

If you have issues creating a test ensure you can call getProductById for the PIID

Authorizations:
OAuth
Request Body schema: application/json
required
Any of
productId
required
string

Product instance identifier

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "productId": "UFFSMPWA0012345",
  • "test": {
    }
}

Response samples

Content type
application/json
{
  • "testId": "5d31f95a-b687-49b2-ac51-bcd780dec92c"
}

Get Diagnostic Test Result

Returns the test result for a given test id

Authorizations:
OAuth
path Parameters
testId
required
string <uuid>

Unique ID of the test

Responses

Response samples

Content type
application/json
Example
{
  • "id": "fb40276b-04aa-4560-bf2b-02b38558d362",
  • "startTime": "2020-11-02T17:52:43.000+13:00",
  • "endTime": "2020-11-02T17:53:03.000+13:00",
  • "sysCreationDate": "2020-11-02T17:52:42.164+13:00",
  • "testStatus": "SUCCESS",
  • "type": "ontStatus",
  • "physicalResourceId": "UFFTGOLTTGE002:0-11-2-6",
  • "productOwner": "Sample RSP",
  • "product": {
    },
  • "result": {
    }
}

Products

Grouping of products related endpoints

Get Product by ID

Retrieves Product instance details

Authorizations:
OAuthOAuth
path Parameters
productId
required
string^[A-Z0-9]{15}$

Unique ID of the Product (PIID)

Responses

Response samples

Content type
application/json
Example
{
  • "piid": "UFFSMPWA0012345",
  • "type": "NGA",
  • "location": {
    },
  • "rsp": {
    },
  • "service": {
    },
  • "ataOffOnt": false,
  • "olt": {
    },
  • "ont": {
    },
  • "dataServices": [
    ],
  • "voiceServices": [ ],
  • "minOperatingRxPowerLevel": 0.2
}

Get Product Logical Configuration by Product ID

Retrieves Logical Configuration details for a Product instance

Authorizations:
OAuthOAuth
path Parameters
productId
required
string^[A-Z0-9]{15}$

Unique ID of the Product (PIID)

Responses

Response samples

Content type
application/json
Example
{
  • "piid": "UFFSMPWA0012345",
  • "ataOffOnt": false,
  • "olt": {
    },
  • "ont": {
    },
  • "dataServices": [
    ],
  • "voiceServices": [ ]
}

Resources

Grouping of resources related endpoints

Get PNI data from ODN

Returns PNI data from ODN using either the SLID, Place Id or Legacy Location Id

Authorizations:
OAuth
query Parameters
q
string
Example: q=XGmvZi1x

Can be used to query by slid, placeId, legacyLocationId or ontSerialNumber, and the system will determine how to handle it.

slid
string
Example: slid=XGmvZi1x

The slid for the POE.

placeId
string
Example: placeId=41001831UFFLC3A

The place id for the address.

legacyLocationId
string
Example: legacyLocationId=0010645200CAF81

The legacy location id for the address.

ontSerialNumber
string
Example: ontSerialNumber=48575443D6F045AA

An alternate way of finding the slid for the POE. If the slid parameter is also specified, this parameter will not be used.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total": 1
}

Outages

Grouping of outages related endpoints

Get Outages

Returns recent or open customer impacting outages caused by change requests and/or network incidents using customerId

Authorizations:
OAuthOAuth
query Parameters
customerId
string
Examples:
  • customerId=1234 - Single Customer ID
  • customerId=1234,5678 - Multiple Customer IDs

The Customer ID for a customer e.g. the customerId for an RSP

type
string
Enum: "ChangeRequest" "NetworkIncident"
Examples:
  • type=ChangeRequest - Change Request
  • type=NetworkIncident - Network Incident

The type of outage to filter by. Can be either 'ChangeRequest' or 'NetworkIncident'. If not specified, both types will be returned.

includeRelatedEntities
boolean
Default: true
Example: includeRelatedEntities=false

Include related entities in the response. Defaults to true.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Outage by ID

Returns details of a specific outage by its ID

Authorizations:
OAuthOAuth
path Parameters
outageId
required
string^(CHG\d+|CS\d+)$

Unique ID of the outage (Outage ID). It should start with either 'CHG' for Change Requests or 'CS' for Network Incidents followed by digits.

query Parameters
customerIds
string
Examples:
  • customerIds=1234 - Single Customer ID
  • customerIds=1234,5678 - Multiple Customer IDs

The Customer ID for a customer e.g. the customerId for an RSP

includeRelatedEntities
boolean
Default: false
Example: includeRelatedEntities=true

Include related entities in the response. Defaults to false.

Responses

Response samples

Content type
application/json
{
  • "id": "CHG0036740",
  • "description": "CHG - Short Description",
  • "category": "Hardware",
  • "detail": "CHG - Description",
  • "plannedStartTime": "2024-04-29T10:30:00.000+12:00",
  • "plannedEndTime": "2024-05-31T11:45:00.000+12:00",
  • "actualStartTime": "2024-04-29T10:30:00.000+12:00",
  • "actualEndTime": "2024-05-31T11:45:00.000+12:00",
  • "status": "Closed",
  • "type": "ChangeRequest",
  • "lastUpdateDate": "2024-03-12T15:01:38.000+13:00",
  • "expectedDowntimePerService": "1 Hours",
  • "closedDate": "2024-05-31T11:45:00.000+12:00",
  • "location": {
    },
  • "closureNote": "Completed within the change window with no additional impact.",
  • "href": "https://api.ultrafastfibre.co.nz/v1/outages/CHG0036740"
}