Diagnostics API

× Please to view API detail.
The Diagnostics API will be used to determine the available diagnostics tests. It also provides the ability to execute these tests and receive the results for a specified Service Number. Details of the available diagnostic tests can be found in the supporting material.The diagnostics results will allow you to identify the primary cause of any issues your services are experiencing.The following operations are supported by the API:available-testsThis operation is used to obtain the access type (ADSL,PSTN, FTTN, FTTP, FTTB, FTTC, Wireless, HFC), sub-access type (Voice, Analog Voice, Broadband, Voice-residential, Voice-business, Faxstream, Adsl l2) and available tests for the specified service number.Sub access type and access type will not be applicable for wideband products Available tests for wideband products are determined by the service‚Äôs topology through the network; the types of devices it transits, what interface types are used, what those interfaces are used for, and what testable capabilities are supported by those devices and interfaces used in that way. It is recommended to call this operation before calling the Initiate Tests operation to avoid requesting a test that is not available.testsThis operation initiates a diagnostic test for a service. The response will be provided in two parts: Synchronous Response: This will provide an acknowledgement the test has been submitted and provide a unique diagnostic test ID, an estimated duration for the test and information regarding your current quota allocation. The processing time for a diagnostic test can range from seconds to minutes depending on the diagnostic test requested.The asynchronous response provides the diagnostic test results. This can either be retrieved using the Get Notification API or based on your preferences, can be pushed to your Push Notification URL for the Diagnostics notification type.diagnostics-detailsThis operation is used to retrieve the diagnostics test details available for a given service by passing the diagnostics ID (Not older than 14 days).diagnostics-historyThis operation is used to retrieve the historical test data up to maximum of 14 days for all the tests initiated by a service.notificationsThis operation is used to retrieve notification messages generated at the time of initiate test by Telstra Wholesale. The notification messages can be retrieved using the Diagnostic ID, Notification ID and Date Ranges.schematicsThis operation is used to retrieve schematics view for the given FNN in wideband.It is recommended that you continue to carry out your normal pre-checks and fault isolation steps in conjunction with the use of the diagnostic API so that accurate determination of the fault cause can occur.Where available, a package test should be executed before individual tests are executed as the package test provides a more comprehensive diagnosis of any issue experienced and minimises the potential of exceeding your quota. Individual tests can be executed as follow up tests to narrow down the specific issue or confirm fault resolution. The supporting material provides information about the available package tests. The /notifications endpoint in Diagnostics API allows you to retrieve notifications generated for you by Telstra Wholesale.You can make up to 20 simultaneous connections. Please contact Telstra Wholesale Support if this parameter needs to be adjusted for your company.BenefitsThe key benefits of Diagnostics API includes the following:Ability to determine available diagnostics tests for a given service number and trigger both Copper, NBN & wideband tests that are not currently available via LOLS or TWCP.Greater variety and details of diagnostics tests exposed (MLT tests, Radius event, DSLAM congestion, Port status,NBN tests etc.).Ability to diagnose issues without relying on Telstra Wholesale reducing resolution times and improving end customer experience.Assurance API OverviewThe Diagnostics API should be incorporated into your assurance processes and used in combination with the other Telstra Wholesale assurance APIs. Please click the download button for an overview of the Telstra Wholesale assurance APIs and their recommended sequencing.DownloadTerms and ConditionsWhen registering for the Telstra Wholesale Diagnostic API, you agree to the following API-specific Terms and Conditions. In addition, use of the Telstra Wholesale Diagnostic API is bound by the overall t-dev Terms and Conditions. You agree to the overall t.dev Terms and Conditions when you sign up an account.You agree and acknowledge that the information provided by this Diagnostics API contains confidential information of Telstra and nbn co and utilises information from nbn co’s Test and Diagnostic Guide (Telstra’s and nbn’s information individually and together the Information).  You must keep the Information confidential and not disclose it to any third party, including your end users. You agree that neither Telstra nor nbn co represents or warrants that the Information is complete, fit for purpose or error-free, and you using or relying upon the Information do so on the basis that neither Telstra nor nbn co accepts responsibility or liability for any errors, faults, defects or omissions in the Information supplied.You may only use the information for fault diagnosis purposes.  You agree and acknowledge that use of this API for nbn tests is subject to Telstra Wholesale’s legal obligations to nbn co, including Telstra Wholesale’s obligation to stop or limit the volume of requests and transactions in certain circumstanc