Uniti Internet DocsIntroduction
Service Qualifications are required to ascertain what type of internet service is available at a specific premise.
Australian premises are usually serviced by a number of wholesalers or carriers. The carriers that Uniti Internet supports in their SQ in descending order of how likely they are to service a premise are:
- nbn®
- Opticomm
- Uniti Fixed Wireless
- Uniti Fixed Line
- Redtrain
Carrier ID Formats
Each carrier creates a unique identifier for each premise within their premise set, it's important to note that most carriers do not service all Australian premises. nbn® has the highest penetration with approximately 14.5 million properties identifiable within their premise set.
The following describes the ID format for each carrier.
| Carrier | Format | Example |
|---|---|---|
| nbn® | /LOC\d\{12\}/ | LOC000000000001 |
| Opticomm | /OPC\d\{12\}/ | OPC000000000001 |
| Uniti Fixed Wireless | GNAF | GASA_414890209 |
| Uniti Fixed Line | GNAF | GASA_414891630 |
| Redtrain | /\d/ | 1 |
Carrier Codes
Additionally each premise is also associated with a carrier code.
| Carrier | Code |
|---|---|
| nbn® | NB |
| Opticomm | OC |
| Uniti Fixed Wireless | UW |
| Uniti Fixed Line | UFL |
| Redtrain | RT |
The combination of the carrier code and a carrier ID constitutes a unique identifier that relates to a single address serviced by a carrier. Importantly a single premise may be serviced by multiple carriers and therefore may be referred to by multiple carrier IDs however will only ever be referred to be a single carrier + carrier ID combination.
For example the following address: UNIT 103, 267 - 277 CASTLEREAGH ST, SYDNEY, NSW 2000 is serviced by both nbn® and Opticomm however multiple SQable entries exist for this singular address.
| Carrier | Carrier ID | Address |
|---|---|---|
| NB | LOC000057539959 | UNIT 103, 267 - 277 CASTLEREAGH ST, SYDNEY, NSW 2000 |
| OC | OPC100000209087 | UNIT 103, 267 - 277 CASTLEREAGH ST, SYDNEY, NSW 2000 |
General Service Qualification Flow
Generally the goal is to turn an address of form UNIT 103, 267 - 277 CASTLEREAGH ST, SYDNEY, NSW 2000 into a result of Service Qualification results which each in turn can be used to determine service availability and meta information such as expected speeds. To do this the address must first be converted to a list of carrier and carrier IDs with which we can then perform a service qualification on.
To start you are able to use the Geographic Address API to perform an address autocomplete. This API call then returns a list of possible addresses that match the input data as well as a list of carrier/carrier ID pairs.
Then make a request to the Service Qualification endpoint with the carrier/carrier ID pairs you wish to SQ for. Eliminating certain carriers/carrier ID pairs ensures that control is maintained over which carriers are SQed and thus serviced.