GeoTypeAheadUSCAN - Spectrum_OnDemand - main

Spectrum OnDemand Web Services (SOAP)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
main
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (SOAP)
First publish date
2006

Resource URL

https://OnDemandServer/soap/GeoTypeAheadUSCAN

For a list of Spectrum OnDemand servers, see Connecting to Spectrum OnDemand Servers.

Example

The following shows a SOAP request:

<soapenv:Envelope
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:geot="http://www.pb.com/spectrum/services/GeoTypeAheadUSCAN">
	<soapenv:Header/>
	<soapenv:Body>
		<geot:GeoTypeAheadUSCANRequest>
			<geot:Input>
				<geot:Row>
					<!--Optional:-->
					<geot:AddressLine1>20 w 34</geot:AddressLine1>
					<!--Optional:-->
					<geot:City></geot:City>
					<!--Optional:-->
					<geot:StateProvince></geot:StateProvince>
					<!--Optional:-->
					<geot:PostCode></geot:PostCode>
					<!--Optional:-->
					<geot:InstanceKey></geot:InstanceKey>
					<!--Optional:-->
					<geot:PostalCode></geot:PostalCode>
					<!--Optional:-->
					<geot:Country></geot:Country>
					<!--Optional:-->
					<geot:IpAddress></geot:IpAddress>
					<!--Optional:-->
					<geot:Latitude>40.7486589707895</geot:Latitude>
					<!--Optional:-->
					<geot:Longitude>-73.98580641773391</geot:Longitude>
					<!--Optional:-->
					<geot:SearchRadius>10</geot:SearchRadius>
					<!--Optional:-->
					<geot:SearchRadiusUnit>Miles</geot:SearchRadiusUnit>
					<!--Optional:-->
					<geot:user_fields>
						<geot:user_field>
							<geot:name></geot:name>
							<geot:value></geot:value>
						</geot:user_field>
					</geot:user_fields>
				</geot:Row>
			</geot:Input>
		</geot:GeoTypeAheadUSCANRequest>
	</soapenv:Body>
</soapenv:Envelope>

This would be the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns3:GeoTypeAheadUSCANResponse xmlns:ns2="http://spectrum.pb.com/" xmlns:ns3="http://www.pb.com/spectrum/services/GeoTypeAheadUSCAN">
         <ns3:Output>
            <ns3:Row>
               <ns3:AddressLine1>20 W 34th St</ns3:AddressLine1>
               <ns3:StateProvince>NY</ns3:StateProvince>
               <ns3:PostalCode>10118</ns3:PostalCode>
               <ns3:City>New York</ns3:City>
               <ns3:ProcessedBy>GGM</ns3:ProcessedBy>
               <ns3:InstanceKey>ACUjMzMTY0MjQyMzIwNzI5MwMz01MD</ns3:InstanceKey>
               <ns3:FormattedAddress>20 W 34th St, New York, NY 10118</ns3:FormattedAddress>
               <ns3:RangeCount>1</ns3:RangeCount>
               <ns3:Ranges>
                  <ns3:Range>
                     <ns3:Range>20</ns3:Range>
                     <ns3:FormattedRangeAddress>20 W 34th St, New York, NY 10118</ns3:FormattedRangeAddress>
                     <ns3:UnitCount>2</ns3:UnitCount>
                     <ns3:UnitsInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>Frnt 1</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, Frnt 1, New York, NY 10118</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>Frnt 2</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, Frnt 2, New York, NY 10118</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                     </ns3:UnitsInfo>
                  </ns3:Range>
               </ns3:Ranges>
               <ns3:Country>USA</ns3:Country>
               <ns3:user_fields/>
            </ns3:Row>
            <ns3:Row>
               <ns3:AddressLine1>20 W 34th St</ns3:AddressLine1>
               <ns3:StateProvince>NJ</ns3:StateProvince>
               <ns3:PostalCode>07002</ns3:PostalCode>
               <ns3:City>Bayonne</ns3:City>
               <ns3:ProcessedBy>GGM</ns3:ProcessedBy>
               <ns3:InstanceKey>ACUjMzMTY0MjQyMzIwNzI5MwMz01MD</ns3:InstanceKey>
               <ns3:FormattedAddress>20 W 34th St, Bayonne, NJ 07002</ns3:FormattedAddress>
               <ns3:RangeCount>1</ns3:RangeCount>
               <ns3:Ranges>
                  <ns3:Range>
                     <ns3:Range>20</ns3:Range>
                     <ns3:FormattedRangeAddress>20 W 34th St, Bayonne, NJ 07002</ns3:FormattedRangeAddress>
                     <ns3:UnitCount>5</ns3:UnitCount>
                     <ns3:UnitsInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>#22</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, #22, Bayonne, NJ 07002</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>Apt 2</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, Apt 2, Bayonne, NJ 07002</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>Apt 5</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, Apt 5, Bayonne, NJ 07002</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>Apt 7</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, Apt 7, Bayonne, NJ 07002</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                        <ns3:UnitInfo>
                           <ns3:UnitInfo>Apt G</ns3:UnitInfo>
                           <ns3:FormattedUnitAddress>20 W 34th St, Apt G, Bayonne, NJ 07002</ns3:FormattedUnitAddress>
                        </ns3:UnitInfo>
                     </ns3:UnitsInfo>
                  </ns3:Range>
               </ns3:Ranges>
               <ns3:Country>USA</ns3:Country>
               <ns3:user_fields/>
            </ns3:Row>
         </ns3:Output>
      </ns3:GeoTypeAheadUSCANResponse>
   </soap:Body>
</soap:Envelope>