Octane REST API
  1. Enquiry
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
    • 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)
        POST
      • Get Enquiry Detail
        GET
      • List Enquiries
        GET
    • 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. Enquiry

Get Enquiry Detail

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
GET
https://benzine.telcoinabox.com/tiab/api
/v1/service/enquiries/{enquiryId}
Retrieves the full detail of an Enquiry showing the result of a Diagnostic Test or Service Health Check

Request

Path Params

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 GET 'https://benzine.telcoinabox.com/tiab/api/v1/service/enquiries/'

Responses

🟢200OK [Diagnostic]
application/json
Body

Example
{
    "id": "string",
    "interactionStatus": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "interactionDate": "string",
    "businessInteractionInvolves": [
        {
            "type": "Submitter",
            "partyRole": {
                "id": "string",
                "type": "string",
                "status": "string",
                "party": {
                    "id": "string",
                    "name": "string",
                    "status": "string"
                }
            }
        }
    ],
    "describedBy": {
        "orderType": "string",
        "serviceId": "string",
        "id": "string",
        "requestedById": "string",
        "diagnosticResult": {
            "nbn_test_id": "string",
            "result": "string",
            "start": "string",
            "end": "string",
            "access_line_rate": "string",
            "actual_cpe_vectoring_type": "string",
            "actual_psd_downstream": "string",
            "actual_psd_upstream": "string",
            "actual_rtx_mode_downstream": "string",
            "actual_rtx_mode_upstream": "string",
            "band_0_attenuation_avg_upstream": "string",
            "band_0_loop_attenuation_avg_upstream": "string",
            "band_1_attenuation_avg_downstream": "string",
            "band_1_attenuation_avg_upstream": "string",
            "band_1_loop_attenuation_avg_downstream": "string",
            "band_1_loop_attenuation_avg_upstream": "string",
            "band_2_attenuation_avg_downstream": "string",
            "band_2_attenuation_avg_upstream": "string",
            "band_2_loop_attenuation_avg_downstream": "string",
            "band_2_loop_attenuation_avg_upstream": "string",
            "band_3_attenuation_avg_downstream": "string",
            "band_3_loop_attenuation_avg_downstream": "string",
            "battery_fail_status": "string",
            "battery_install_date": "string",
            "battery_missing_status": "string",
            "c_vlan_id": "string",
            "config_status": "string",
            "detected_mac_addresses": "string",
            "dsl_mode": "string",
            "electrical_length": "string",
            "estimated_delt_distance": "string",
            "fallback_state": "string",
            "flaps": "string",
            "last_flap_time": "string",
            "link_state": "string",
            "link_type": "string",
            "mac_address": "string",
            "mac_address_end_user_gateway": "string",
            "modem_name": "string",
            "modem_vendor_id": "string",
            "ncd_uni_d_port_speed_duplex": "string",
            "ncd_uni_d_port_configuration": "string",
            "noise_margin_avg_downstream": "string",
            "noise_margin_avg_upstream": "string",
            "ntd_uni_d_state": "string",
            "operational_state": "string",
            "operational_status": "string",
            "output_power_downstream": "string",
            "output_power_upstream": "string",
            "physical_profile": "string",
            "port_number": "string",
            "power_type": "string",
            "relative_capacity_occupation_downstream": "string",
            "relative_capacity_occupation_upstream": "string",
            "reporting_state": "string",
            "reserve_power_state": "string",
            "rtx_actual_expected_throughput_downstream": "string",
            "rtx_actual_expected_throughput_upstream": "string",
            "rtx_actual_net_data_rate_downstream": "string",
            "rtx_actual_net_data_rate_upstream": "string",
            "rtx_attainable_expected_throughput_downstream": "string",
            "rtx_attainable_expected_throughput_upstream": "string",
            "rtx_attainable_net_data_rate_downstream": "string",
            "rtx_attainable_net_data_rate_upstream": "string",
            "s_vlan_id": "string",
            "serial_number": "string",
            "service_stability": "STABLE",
            "supported_cpe_vectoring_types": "string",
            "sync_state": "string",
            "system_vendor_id": "string",
            "system_vendor_model": "string",
            "uptime": "string",
            "user_traffic_downstream": "string",
            "user_traffic_upstream": "string",
            "vectoring_status": "string",
            "notes": "string"
        }
    },
    "externalReferences": [
        {
            "referenceId": "string",
            "system": "string"
        }
    ],
    "priority": "string",
    "completionDate": "string",
    "notes": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "creatorName": "string",
            "creationDate": "string",
            "type": "string"
        }
    ],
    "customerReference": "string"
}
🟢200OK [Service Health Check]
🟠403Invalid access
Modified at 2024-02-22 21:14:27
Previous
Create Enquiry (NBN Diagnostic Test / Service Health Check)
Next
List Enquiries
Built with