GeocodeAddressUSA - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (SOAP)

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

GeocodeAddressUSA takes an address and returns latitude/longitude coordinates. GeocodeAddressUSA also standardizes and validates addresses using data from the U.S. Postal Service.

GeocodeAddressUSA can also geocode intersections. Instead of entering a mailing address, you can enter and intersection such as "Pearl St. and 28th" and obtain the coordinates of the intersection.

GeocodeAddressUSA is part of Enterprise Geocoding. For more information, see ee Enterprise Geocoding.

GeocodeAddressUSA takes an address as input. All addresses use this format regardless of the address's country. See Address Line Processing for U.S. Addresses for important information about how address line data is processed for U.S. addresses.

Resource URL

https://OnDemandServer/soap/GeocodeAddressUSA

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

Example

This shows a SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:geoc="http://www.pb.com/spectrum/services/GeocodeAddressUSA">
   <soapenv:Header/>
   <soapenv:Body>
      <geoc:GeocodeAddressUSARequest>
         <!--Optional:-->
         <geoc:options>
            <!--Optional:-->
            <geoc:Offset>60</geoc:Offset>
            <!--Optional:-->
            <geoc:PerformLACSLink></geoc:PerformLACSLink>
            <!--Optional:-->
            <geoc:SearchDistance>160</geoc:SearchDistance>
            <!--Optional:-->
            <geoc:CentroidPreference></geoc:CentroidPreference>
            <!--Optional:-->
            <geoc:RetrieveElevation></geoc:RetrieveElevation>
            <!--Optional:-->
            <geoc:PreferZipCodeOverCity></geoc:PreferZipCodeOverCity>
            <!--Optional:-->
            <geoc:MustMatchStateProvince></geoc:MustMatchStateProvince>
            <!--Optional:-->
            <geoc:FIND_APPROXIMATE_PBKEY></geoc:FIND_APPROXIMATE_PBKEY>
            <!--Optional:-->
            <geoc:FallbackToStreet></geoc:FallbackToStreet>
            <!--Optional:-->
            <geoc:OutputRecordType></geoc:OutputRecordType>
            <!--Optional:-->
            <geoc:MustMatchPostalCode></geoc:MustMatchPostalCode>
            <!--Optional:-->
            <geoc:OutputFields></geoc:OutputFields>
            <!--Optional:-->
            <geoc:PerformDPV></geoc:PerformDPV>
            <!--Optional:-->
            <geoc:OutputCasing></geoc:OutputCasing>
            <!--Optional:-->
            <geoc:PredictiveLastLine></geoc:PredictiveLastLine>
            <!--Optional:-->
            <geoc:KeepCandidates></geoc:KeepCandidates>
            <!--Optional:-->
            <geoc:FirstLetterSearch></geoc:FirstLetterSearch>
            <!--Optional:-->
            <geoc:FIND_SEARCH_AREA_DISTANCE>50</geoc:FIND_SEARCH_AREA_DISTANCE>
            <!--Optional:-->
            <geoc:CenterlineOffset>0</geoc:CenterlineOffset>
            <!--Optional:-->
            <geoc:OutputVerbose></geoc:OutputVerbose>
            <!--Optional:-->
            <geoc:ExtendedMatchCode></geoc:ExtendedMatchCode>
            <!--Optional:-->
            <geoc:OutputFormattedOnFail></geoc:OutputFormattedOnFail>
            <!--Optional:-->
            <geoc:Squeeze>60</geoc:Squeeze>
            <!--Optional:-->
            <geoc:OutputPostalCodeSeparator></geoc:OutputPostalCodeSeparator>
            <!--Optional:-->
            <geoc:LatLonFormat></geoc:LatLonFormat>
            <!--Optional:-->
            <geoc:AddressPreference></geoc:AddressPreference>
            <!--Optional:-->
            <geoc:MatchMode></geoc:MatchMode>
            <!--Optional:-->
            <geoc:Datum></geoc:Datum>
            <!--Optional:-->
            <geoc:Dataset>GDT+MLD</geoc:Dataset>
            <!--Optional:-->
            <geoc:MustMatchStreet></geoc:MustMatchStreet>
            <!--Optional:-->
            <geoc:AddressPointInterpolation></geoc:AddressPointInterpolation>
            <!--Optional:-->
            <geoc:BuildingSearch></geoc:BuildingSearch>
            <!--Optional:-->
            <geoc:RetrieveAPN></geoc:RetrieveAPN>
            <!--Optional:-->
            <geoc:FirmNameSearch></geoc:FirmNameSearch>
            <!--Optional:-->
            <geoc:CloseMatchesOnly></geoc:CloseMatchesOnly>
            <!--Optional:-->
            <geoc:KeepMultimatch></geoc:KeepMultimatch>
            <!--Optional:-->
            <geoc:MustMatchHouseNumber></geoc:MustMatchHouseNumber>
            <!--Optional:-->
            <geoc:AlwaysFindCandidates></geoc:AlwaysFindCandidates>
            <!--Optional:-->
            <geoc:MustMatchCity></geoc:MustMatchCity>
            <!--Optional:-->
            <geoc:FIND_SEARCH_AREA></geoc:FIND_SEARCH_AREA>
            <!--Optional:-->
            <geoc:FallbackToGeographic></geoc:FallbackToGeographic>
         </geoc:options>
         <!--Optional:-->
         <geoc:Input>
            <!--Zero or more repetitions:-->
            <geoc:Address>
               <!--You may enter the following 15 items in any order-->
               <!--Optional:-->
               <geoc:InputKeyValue></geoc:InputKeyValue>
               <!--Optional:-->
               <geoc:FirmName></geoc:FirmName>
               <!--Optional:-->
               <geoc:AddressLine1>103 DAVIDSON</geoc:AddressLine1>
               <!--Optional:-->
               <geoc:AddressLine2></geoc:AddressLine2>
               <!--Optional:-->
               <geoc:AddressLine3></geoc:AddressLine3>
               <!--Optional:-->
               <geoc:AddressLine4></geoc:AddressLine4>
               <!--Optional:-->
               <geoc:AddressLine5></geoc:AddressLine5>
               <!--Optional:-->
               <geoc:AddressLine6></geoc:AddressLine6>
               <!--Optional:-->
               <geoc:LastLine></geoc:LastLine>
               <!--Optional:-->
               <geoc:City>WHITNEY</geoc:City>
               <!--Optional:-->
               <geoc:StateProvince>TX</geoc:StateProvince>
               <!--Optional:-->
               <geoc:PostalCode>76692</geoc:PostalCode>
               <!--Optional:-->
               <geoc:Longitude></geoc:Longitude>
               <!--Optional:-->
               <geoc:Latitude></geoc:Latitude>
               <!--Optional:-->
               <geoc:user_fields>
                  <!--Zero or more repetitions:-->
                  <geoc:user_field>
                     <geoc:name></geoc:name>
                     <geoc:value></geoc:value>
                  </geoc:user_field>
               </geoc:user_fields>
            </geoc:Address>
         </geoc:Input>
      </geoc:GeocodeAddressUSARequest>
   </soapenv:Body>
</soapenv:Envelope>

This would be the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns3:GeocodeAddressUSAResponse xmlns:ns2="http://spectrum.pb.com/" xmlns:ns3="http://www.pb.com/spectrum/services/GeocodeAddressUSA">
         <ns3:Output>
            <ns3:Address>
               <ns3:Confidence>100</ns3:Confidence>
               <ns3:ProcessedBy>KGL</ns3:ProcessedBy>
               <ns3:StreetDataType>MASTER LOCATION</ns3:StreetDataType>
               <ns3:LocationCode>AP05</ns3:LocationCode>
               <ns3:MatchCode>S80</ns3:MatchCode>
               <ns3:AdditionalInputData/>
               <ns3:AddressLine1>103 Davidson</ns3:AddressLine1>
               <ns3:AddressLine2/>
               <ns3:City>Whitney</ns3:City>
               <ns3:Country>United States of America</ns3:Country>
               <ns3:FirmName/>
               <ns3:LastLine>Whitney, TX  76692-2419</ns3:LastLine>
               <ns3:PostalCode>76692-2419</ns3:PostalCode>
               <ns3:PostalCode.Base>76692</ns3:PostalCode.Base>
               <ns3:PostalCode.AddOn>2419</ns3:PostalCode.AddOn>
               <ns3:StateProvince>TX</ns3:StateProvince>
               <ns3:USUrbanName/>
               <ns3:PBKey>P0000M3JVXVE</ns3:PBKey>
               <ns3:Latitude>31.956404</ns3:Latitude>
               <ns3:Longitude>-97.316833</ns3:Longitude>
               <ns3:StreetSide>L</ns3:StreetSide>
               <ns3:StreetSegmentPoints/>
               <ns3:InputKeyValue/>
               <ns3:AddressLine3/>
               <ns3:AddressLine4/>
               <ns3:AddressLine5/>
               <ns3:AddressLine6/>
               <ns3:Status/>
               <ns3:Status.Code/>
               <ns3:Status.Description/>
               <ns3:PreciselyId>P0000M3JVXVE</ns3:PreciselyId>
               <ns3:Block2010>482179605002079</ns3:Block2010>
               <ns3:user_fields>
                  <ns3:user_field>
                     <ns3:name/>
                     <ns3:value/>
                  </ns3:user_field>
               </ns3:user_fields>
            </ns3:Address>
         </ns3:Output>
      </ns3:GeocodeAddressUSAResponse>
   </soap:Body>
</soap:Envelope>