API/Orders/FindNWBSQAddress - Revision history

Medge at 01:30, 15 February 2019

2019-02-15T01:30:47Z

Scarpenter at 06:56, 29 June 2016

2016-06-29T06:56:37Z

Scarpenter: 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..."

2016-06-29T01:04:58Z

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..."

New page

=== 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 [[API/Orders/PerformNWBSQ|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>

@@ Line 23: / Line 23: @@
 * StreetTypeSuffix: string - Optional
 * Suburb: string - Required
-* State: string - Required
+* State: string - Required (Use Abbreviations as per XSD)
 * Postcode: int - Required
@@ Line 59: / Line 59: @@
              <ord:StreetTypeSuffix>?</ord:StreetTypeSuffix>
              <ord:Suburb>Melbourne</ord:Suburb>
-             <ord:State>Victoria</ord:State>
+             <ord:State>VIC</ord:State>
              <ord:Postcode>3000</ord:Postcode>
           </ord:AddressDetails>

@@ Line 25: / Line 25: @@
 * State: string - Required
 * Postcode: int - Required
        <ord:FindNWBSQAddressRequest>
@@ Line 63: / Line 64: @@
        </ord:FindNWBSQAddressRequest>
-'''Output:'''
+'''Output'''
-	<ord:FindNWBSQAddressRequest>
+	<ord:FindNWBSQAddressResponse>
 		<ord:Address>
 			<ord:ServiceProvider>Telstra</ord:ServiceProvider>
@@ Line 71: / Line 72: @@
 			<ord:LocationName>460 Bourke Street, Melbourne 3000</ord:LocationName>
 		</ord:Address>
-	</ord:FindNWBSQAddressRequest>
+	</ord:FindNWBSQAddressResponse>