API/Orders/FindNWBSQAddress

From Emersion
Revision as of 11:04, 29 June 2016 by Scarpenter (talk) (Created page with "=== Find NWB SQ Address === '''Purpose:''' This method is part of the address-based service qualification (SQ) requirements for the AAPT NwB service type. It searches and retr...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Find NWB SQ Address

Purpose: This method is part of the address-based service qualification (SQ) requirements for the AAPT NwB service type. It searches and retrieves a Location ID based upon an address selected by the user. This location ID is then used by the Perform NWB SQ method to complete the SQ process.

WSDL: Orders.wsdl

Input

  • ServiceTypeID: int - Required
  • AddressDetails: Array
  • RuralMailNumber: string - Optional
  • RuralMailType: string - Optional
  • LevelNumber: string - Optional
  • LevelType: string - Optional
  • UnitNumber: string - Optional
  • UnitType: string - Optional
  • PlanNumber: string - Optional
  • LotNumber: string - Optional
  • StreetNumber: string - Optional
  • StreetNumberSuffix: string - Optional
  • SiteName: string - Optional
  • StreetName: string - Optional
  • StreetType: string - Optional
  • StreetTypeSuffix: string - Optional
  • Suburb: string - Required
  • State: string - Required
  • Postcode: int - Required
     <ord:FindNWBSQAddressRequest>
        <ord:ServiceTypeID>3261</ord:ServiceTypeID>
        <ord:AddressDetails>
           <ord:RuralMailNumber>?</ord:RuralMailNumber>
           <ord:RuralMailType>?</ord:RuralMailType>
           <ord:LevelNumber>?</ord:LevelNumber>
           <ord:LevelType>?</ord:LevelType>
           <ord:UnitNumber>?</ord:UnitNumber>
           <ord:UnitType>?</ord:UnitType>
           <ord:PlanNumber>?</ord:PlanNumber>
           <ord:LotNumber>?</ord:LotNumber>
           <ord:StreetNumber>?</ord:StreetNumber>
           <ord:StreetNumberSuffix>?</ord:StreetNumberSuffix>
           <ord:SiteName>?</ord:SiteName>
           <ord:StreetName>?</ord:StreetName>
           <ord:StreetType>?</ord:StreetType>
           <ord:StreetTypeSuffix>?</ord:StreetTypeSuffix>
           <ord:Suburb>Melbourne</ord:Suburb>
           <ord:State>Victoria</ord:State>
           <ord:Postcode>3000</ord:Postcode>
        </ord:AddressDetails>
     </ord:FindNWBSQAddressRequest>

Output:

<ord:FindNWBSQAddressRequest> <ord:Address> <ord:ServiceProvider>Telstra</ord:ServiceProvider> <ord:LocationID>XXXXXXXX</ord:LocationID> <ord:LocationName>460 Bourke Street, Melbourne 3000</ord:LocationName> </ord:Address> </ord:FindNWBSQAddressRequest>