Go to full article


Overview

This API call can be used to perform a stand alone SQ request for service types 

  • AAPT NWB Layer 2
  • AAPT NWB Layer 3
  • Vocus NBN

WSDL

https://api.emersion.com.au/Orders.wsdl

Operation name

PerformNBNSQ


SOAP Example

API Call
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:PerformNBNSQRequest>
         <urn:SearchType>NBNLocationId</urn:SearchType>
         <urn:SearchValue>LOC000176944782</urn:SearchValue>
         <urn:ServiceType>AAPT National Wholesale Broadband Layer 2</urn:ServiceType>
         <urn:ReturnFail>false</urn:ReturnFail>
      </urn:PerformNBNSQRequest>
   </soapenv:Body>
</soapenv:Envelope>


API Reseponse
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api" xmlns:ns2="urn:emersion:types">
   <SOAP-ENV:Body>
      <ns1:PerformNBNSQResponse>
         <ns1:QualificationId>0</ns1:QualificationId>
         <ns1:Carrier>Vocus</ns1:Carrier>
         <ns1:ServiceType>Vocus NBN</ns1:ServiceType>
         <ns1:QualificationResponses>
            <ns1:QualificationResponse>
               <ns2:SQResult>PASS</ns2:SQResult>
               <ns2:Product>Vocus NBN</ns2:Product>
               <ns2:Type>Fibre to the node</ns2:Type>
               <ns2:Availability>NBN FTTN</ns2:Availability>
               <ns2:ServiceClass>13</ns2:ServiceClass>
               <ns2:CSAID>CSA200000000549</ns2:CSAID>
               <ns2:Zone>Urban</ns2:Zone>
               <ns2:CopperDisconnection>2018-06-08</ns2:CopperDisconnection>
               <ns2:NetworkCoExistence>false</ns2:NetworkCoExistence>
               <ns2:ServiceSpeeds>
                  <ns2:ServiceSpeed>Upload Speed (CPI CPI300002082017): 33-40</ns2:ServiceSpeed>
                  <ns2:ServiceSpeed>Download Speed: (CPI CPI300002082017): 73-100</ns2:ServiceSpeed>
               </ns2:ServiceSpeeds>
               <ns2:ConnectionType>Brown Fields</ns2:ConnectionType>
               <ns2:LocationID>LOC000025391315</ns2:LocationID>
               <ns2:Address>LOC000025391315</ns2:Address>
               <ns2:DevelopmentChargeApplies>false</ns2:DevelopmentChargeApplies>
               <ns2:CVCID>Auto-Assigned</ns2:CVCID>
               <ns2:VoiceCVCID>Auto-Assigned</ns2:VoiceCVCID>
            </ns1:QualificationResponse>
         </ns1:QualificationResponses>
      </ns1:PerformNBNSQResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope







Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information..

NameDescriptionRequired?Field Type

Character

limit

Values
SearchType
The type of identifier you will perform an SQ with.YesString

Valid values are:

FullNationalNumber

TelstraLocationId

NBNLocationId



SearchValue
The actual identifier for the SQ.YesString

Examples of each type are:

FullNationalNumber: 0397731234

TelstraLocationId

NBNLocationId: LOC000176944782


ServiceType
Service Type for the SQ.YesString

Valid values:

AAPT National Wholesale Broadband Layer 2

AAPT National Wholesale Broadband Layer 3

Vocus NBN

ReturnFail
With this field you can elect to return results for speeds and access methods where the SQ failed, or only those where the SQ result passed.YesString
Valid values are true and false.