NBN Activate Flow
Overview
Key
| Icon | Description |
|---|---|
| Telcoinabox | |
| Service Provider / Website |
API Sequence
| Step | Action | Publisher | Consumer | API Guide | M/O | Comments/Other Info | Type |
|---|---|---|---|---|---|---|---|
| 1 | Check Address | Search for an Address | Mandatory | This API is used to search for an address and returns unique Location IDs for any addresses matched | REST | ||
| 2 | SQ Check | Perform Service Qualification Check | Mandatory | This API allows you to run a service qualification check on a Location ID returned by the Address Search API. Service Qualification will either be done via nbnCo or Opticomm, depending on what technology is enabled at the Location | REST | ||
| 3 | Get Plans | List Plans | Mandatory | This API is used to retrieve a list of plans that the Service can be sold onto, so that the User can select what plan they want | REST | ||
| 4 | Create Customer | Add Customer | Optional | This API is used to create a new Customer. A Customer account must first be created to place the Order against. Optionally, if the order is being placed against an existing Customer Account. The Get Customer Detail API can be called to retrieve details | REST | ||
| 5 | Get Customer | Get Customer Detail | Optional | This API returns Customer Details about an existing customers. This API can be used if the Order is being placed against an already existing Customer Account | REST | ||
| 6 | Create Activation Order | Create Order (NBN Activation) | Mandatory | This API is used to submit an order to activate an NBN services. You will need to pass details captured from the Service Qualification Response, the Add/Get Customer Response and one of the Plans returned by Get Plans to submit the order | REST | ||
| 7 | Check Order Status/Detail | Get Order Detail | Optional | This API can be used to query the status of an order once it has been submitted | REST | ||
| 8 | Get Service Detail | Get Service Detail | Optional | This API can be used to retrieve the Service Detail of the provisioned service once the Activation order has completed | REST |
Modified at 2024-04-23 04:52:02