Difference between revisions of "API/Orders/FindNWBSQAddress"

Latest revision as of 11:30, 15 February 2019

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 (Use Abbreviations as per XSD)
• 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>VIC</ord:State>
           <ord:Postcode>3000</ord:Postcode>
        </ord:AddressDetails>
     </ord:FindNWBSQAddressRequest>

Output

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

Error String

• "Missing service type id" : Service type id is not supplied or less than 1
• "Undefined service type": service type does note exist or not belong to the account.
• "Service type is not available for ordering" : Service type id is not exist in sellable service type
• "Missing service check type on service type id #XXXXXX" : Service type does not has service check type
• "Service type id #XXXXXX is not qualified for NWB SQ : Service type service check type is not VOIPFNN
• "Missing address Details": Address details is not supplied or provided.
• "Missing state": Address state is not supplied.
• "Undefined state": Address state does not exist.
• "Missing postcode": postcode is not supplied.
• "Invalid postcode": postcode is not 4 digits number.
• "Undefined street type": Address street type does not exist.
• "Undefined street type suffix": Address street type suffix does not exist.