Octane REST API
  1. Service Qualification
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
        POST
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. Service Qualification

Perform Service Qualification Check

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
POST
https://benzine.telcoinabox.com/tiab/api
/v1/qualification/check
qualification
Perform a Service Qualification check on a Location ID to determine what products are available.
The API currently only supports Service Qualification for the NBN TC4 and Opticomm Layer-3 products.
The API will return different responses depending on the technology type at the address. Different response types are detailed below.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Body Params application/json
productSelection
enum<string> 
required
The product to do service qualification for
Allowed value:
nbn
locationId
string 
required
The Location ID to perform service qualification on.
csn
string 
optional
For Copper-based technology types where a customer is transitioning their old copper service to NBN, you can supply their current service to validate against the Location provided. The SQ will indicate whether the CSN was matched to the Location ID, and also what Copper Pair ID it’s connected on.
pri
string 
optional
For internal use only.
sqType
enum<string> 
optional
Indicates whether to do a standard SQ or NFAS (FTTP Upgrade) SQ. If not provided, standard SQ will be done
Allowed value:
NFAS
Example
{
    "productSelection": "nbn",
    "locationId": "string",
    "csn": "string",
    "pri": "string",
    "sqType": "NFAS"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://benzine.telcoinabox.com/tiab/api/v1/qualification/check' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "productSelection": "nbn",
    "locationId": "string",
    "csn": "string",
    "pri": "string",
    "sqType": "NFAS"
}'

Responses

🟢200OK
application/json
Body
qualificationSearchId
string 
required
The unique identifier of the qualification request. This ID must be passed on the Create Order request.
remoteOrderId
string 
required
The unique identifier of the qualification request. This ID must be passed on the Create Order request.
remoteQualificationSearchId
string 
required
The unique identifier of the qualification request. This ID must be passed on the Create Order request.
productSelection
string 
required
List of products that have been qualified as part of this request
csn
string 
required
The CSN qualified as part of this request. SQ will confirm if CSN exists at the Location ID provided and if it can be used for Transition.
dateSubmitted
string 
required
The datetime the request was processed
fee
array [object {3}] 
required
This collection will return a list of fees that apply to the Location, if an order is placed against it
applies
boolean 
required
Indicator of whether fee applies for this address or not
chargeAmount
number 
required
The total charge that will be applicable
type
enum<string> 
required
The type of fee that will be applicable
Allowed value:
NDC
infrastructures
array [object {21}] 
required
This collection will return a list of Infrastructures currently present at this location. It will return CPIs (Copper Pair IDs) for Copper tech types, or NTDs (Network Termination Devices) for all other Tech Types
id
string 
optional
Returns the infrastructure ID that's available at the address
recommended
boolean 
optional
Indicates which Copper Path or NTD is the recommended option
serviceClass
enum<string> 
optional
The service class associated with the specific Infrastructure option. Relevant to Copper Pairs.
Allowed values:
01234561011121320212223243031323334
serviceStatus
enum<string> 
optional
Indicates whether the Copper Path is currently in-use by an active service. Relevant to Copper Pairs.
Allowed values:
Line In UseLine Not In Use
serviceType
enum<string> 
optional
Indicator of the type of service currently active on the Copper Pair
Allowed values:
FNNFNN - SpecialULL - Special
copperPairStatus
string 
optional
Indicator of the status of the service that’s currently linked to the Copper Pair
networkCoexistence
string 
optional
Denotes whether Copper Pair has a network coexistence. Relevant to Copper Pairs
orderType
enum<string> 
optional
Indicator of the type of order that will be required if this Infrastructure Option is selected
Allowed values:
NewTransferTransition
hasActivePots
boolean 
optional
Indicates whether there is an active PSTN service linked to this infrastructure option
potsInterconnect
string 
optional
Will display the CSN provided on the SQ Request if it matches this Infrastructure ID
potsInterconnectMatch
boolean 
optional
Indicates whether the CSN provided for verification matches this infrastructure option. This infrastructure option should be picked for transfer/transition if it matches the CSN
ntdLocation
string 
optional
Location of the NTD at the premises
ntdPowerType
string 
optional
Power type of the NTD
ntdSelfInstallEligible
boolean 
optional
Indication of whether or not this Infrastructure Option is eligible for NTD Self Installation
ntdType
string 
optional
Type of NTD at the address
batteryPowerUnit
string 
optional
Indicator of whether Battery Power Unit exists at the address
referencedData
object 
optional
This object will contain information about the active service currently on this NTD Port
fee
array [object {3}] 
optional
This collection will return a list of fees that apply to an Infrastructure Option, if an order is placed against it
installationOptions
array [object {4}] 
optional
This collection will return a list of install options available for the Infrastructure Option - one or more options will be returned depending on the Service Class
ntdPort
array [object {6}] 
optional
A list of all NTD Ports for the NTD and their status
speedProfile
object 
optional
Speed Profile will be returned for FTTB/FTTN/FTTC locations - this gives an indication of estimated speed that can be obtained
location
object 
required
The Location object holds all the details about the Location that has been Qualified by the Request
id
string 
required
The NBN Location ID that the SQ has been performed on
serviceClass
string 
optional
Service Class at the address
serviceClassDescription
string 
optional
Description of the Service Class returned
technologyType
enum<string> 
required
Technology Type at the address
Allowed values:
FTTPFWFTTNFTTBFTTCHFCMixed
technologyTypeDescription
string 
required
Description of the Tech Type returned
addressString
string 
required
Concatenated address string for the location
buildingName
string 
optional
The building/property name of the location
buildingLevel
string 
optional
The building level of the location
unitNumber
string 
optional
The sub address number of the Location
streetNumber
string 
optional
The street number of the Location
street
string 
required
The street name of the Location
suburb
string 
required
The suburb name of the Location
postcode
string 
required
The postcode of the location
state
string 
required
The state of the location
region
string 
optional
Region classification for the address
gpsLatitude
number 
optional
The GPS Latitude coordinates of the address
gpsLongitude
number 
optional
The GPS Longitude coordinates of the address
locationIdentifiers
array [object {3}] 
optional
Returns a list of Location Identifiers used to classify the location that has been SQed
product
array [object {3}] 
optional
Returns 1 or more Products that have been qualified as part of the Service Qualification request
productName
string 
required
Returns the name of the Product that's available at the location
productResult
enum<string> 
required
Returns the qualification result for the product
Allowed values:
PassFail
productResultReason
string 
required
Returns the reason for the result
Examples
{
    "errorCode": 0,
    "errorMessage": "Service qualification is successful",
    "success": true,
    "response": {
        "remoteOrderId": "f0952fd6-e268-4ea3-8722-5dfaed62359c",
        "qualificationSearchId": "7bf06020-06b1-4b92-a411-f7fd1079777a",
        "remoteQualificationSearchId": "7726fff8-1cb3-4362-aee5-fced39481135",
        "productSelection": "nbn",
        "dateSubmitted": "18-04-2024",
        "location": {
            "id": "LOC380100000995",
            "addressString": "995 UTRILLO Place, BOX HILL NORTH, Victoria, 3129",
            "streetNumber": "995",
            "street": "UTRILLO Place",
            "suburb": "BOX HILL NORTH",
            "state": "Victoria",
            "postcode": "3129",
            "gpsLatitude": "-33.38010995",
            "gpsLongitude": "151.38010995",
            "technologyType": "FTTP",
            "technologyTypeDescription": "Fibre",
            "serviceClass": "3",
            "serviceClassDescription": "Location serviced by FTTP and has infrastructure in place",
            "region": "Urban",
            "locationIdentifiers": {
                "type": "POI",
                "id": "3ABC",
                "name": "Fake POI"
            }
        },
        "product": {
            "productName": "tc4",
            "productResult": "Pass",
            "productResultReason": "serviceable",
            "supportedProductFeatures": [
                {
                    "name": "AuthenticationType",
                    "value": "IPoE"
                },
                {
                    "name": "IPType",
                    "value": "Static"
                }
            ]
        },
        "infrastructures": [
            {
                "id": "NTD380100010995",
                "ntdType": "INTERNAL",
                "ntdPowerType": "AC",
                "batteryPowerUnit": "No",
                "ntdLocation": "INDOOR",
                "ntdPort": [
                    {
                        "portId": "1",
                        "portName": "1-UNI-D1",
                        "uniType": "UNI-D",
                        "status": "Used",
                        "fee": {
                            "type": "SERVICE_TRANSFER_FEE",
                            "chargeAmount": 5.5
                        },
                        "referencedData": {
                            "productInstanceId": "PRI380100110995",
                            "serviceProviderId": "0615",
                            "serviceProviderName": null,
                            "owner": true
                        }
                    },
                    {
                        "portId": "2",
                        "portName": "1-UNI-D2",
                        "uniType": "UNI-D",
                        "status": "Used",
                        "fee": {
                            "type": "SERVICE_TRANSFER_FEE",
                            "chargeAmount": 5.5
                        },
                        "referencedData": {
                            "productInstanceId": "PRI380100210995",
                            "serviceProviderId": "0615",
                            "serviceProviderName": null,
                            "owner": false
                        }
                    },
                    {
                        "portId": "3",
                        "portName": "1-UNI-D3",
                        "uniType": "UNI-D",
                        "status": "Used",
                        "fee": {
                            "type": "SERVICE_TRANSFER_FEE",
                            "chargeAmount": 5.5
                        },
                        "referencedData": {
                            "productInstanceId": "PRI380100310995",
                            "serviceProviderId": "0615",
                            "serviceProviderName": null,
                            "owner": false
                        }
                    },
                    {
                        "portId": "4",
                        "portName": "1-UNI-D4",
                        "uniType": "UNI-D",
                        "status": "Used",
                        "fee": {
                            "type": "SERVICE_TRANSFER_FEE",
                            "chargeAmount": 5.5
                        },
                        "referencedData": {
                            "productInstanceId": "PRI380100410995",
                            "serviceProviderId": "0615",
                            "serviceProviderName": null,
                            "owner": false
                        }
                    }
                ],
                "installationOptions": [
                    {
                        "option": "nbn-no-action",
                        "recommended": true
                    }
                ]
            },
            {
                "id": "NTD380100020995",
                "ntdType": "INTERNAL",
                "ntdPowerType": "AC",
                "batteryPowerUnit": "No",
                "ntdLocation": "INDOOR",
                "ntdPort": [
                    {
                        "portId": "1",
                        "portName": "2-UNI-D1",
                        "uniType": "UNI-D",
                        "status": "Free"
                    },
                    {
                        "portId": "2",
                        "portName": "2-UNI-D2",
                        "uniType": "UNI-D",
                        "status": "Used",
                        "fee": {
                            "type": "SERVICE_TRANSFER_FEE",
                            "chargeAmount": 5.5
                        }
                    },
                    {
                        "portId": "3",
                        "portName": "2-UNI-D3",
                        "uniType": "UNI-D",
                        "status": "Free"
                    },
                    {
                        "portId": "4",
                        "portName": "2-UNI-D4",
                        "uniType": "UNI-D",
                        "status": "Free"
                    }
                ],
                "installationOptions": [
                    {
                        "option": "nbn-no-action",
                        "recommended": true
                    }
                ]
            },
            {
                "id": "SUBSEQUENT_INSTALL",
                "installationOptions": [
                    {
                        "option": "nbn-tech",
                        "recommended": true,
                        "fee": {
                            "type": "SUBSEQUENT_INSTALLATION_CHARGE",
                            "chargeAmount": 270
                        }
                    }
                ]
            }
        ],
        "fee": {
            "type": "NDC",
            "chargeAmount": 0,
            "applies": "false"
        },
        "sqType": "STANDARD"
    }
}
🟠403Invalid access
Modified at 2024-12-02 02:48:12
Previous
Search for an Address V2
Next
Create Order (NBN Activation)
Built with