Chapter 3.2 - Geocode All Matches

The GeocodeAllMatches method accepts an address input and returns all matches above the minimum score (MinimumScore) requested, up to the requested match count (matchCount).

GeocodeAllMatches Example 1

This request contains the following:

  • CASS validation is on (CassCertify set to true)
  • MinimumScore is 0.7 - requesting addresses with a score of 0.7 or greater
  • Offset (Offset) set to 3, meaning that we are requesting that the input location is 3 meters from the side of the link
  • Options (Options) bitwise value set to 312, being comprised of:
    • Return Zip+4: 8
    • Return Special Tax Jurisdictions: 16
    • Return Census IDs: 32
    • Return Building Zip Code: 256
  • Match count (matchCount) is 10 - results are limited to 10 addresses returned
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <o:UsernameToken>
            <o:Username>USERNAME</o:Username>
            <o:Password>PASSWORD</o:Password>
         </o:UsernameToken>
      </o:Security>
   </s:Header>
   <s:Body>
      <tem:GeocodeAllMatches>
         <tem:inputAddress xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:CassCertify>true</a:CassCertify>
            <a:City/>
            <a:CityStateZip>Denver,CO 80111</a:CityStateZip>
            <a:MinimumScore>0.7</a:MinimumScore>
            <a:Offset>3</a:Offset>
            <a:Options>312</a:Options>
            <a:SecondaryUnit/>
            <a:Source/>
            <a:State/>
            <a:StreetAddress>6465 Greenwood Plaza Blvd</a:StreetAddress>
            <a:Zip/>
         </tem:inputAddress>
         <tem:matchCount>10</tem:matchCount>
      </tem:GeocodeAllMatches>
   </s:Body>
</s:Envelope>

Response

The GeocodeAllMatchesResponse contains detailed address information for 2 matching addresses. The records returned contain detailed information including:

  • CassAddress: CASS information including Carrier Route, USPS Barcode, and standardized address
  • Census block and tract information
  • PCode, FeatureID, and FipsCode
  • Results are from different sources
    • First address is from TeleAtlas (NetworkID is ta)
    • Second address is from NavTeq (NetworkID is nt)
  • AFC Geo SaaS Pro Soap score is different on the records:
  • First address has a score (Score) of .97 (97%)
  • Second address has a score (Score) rounded to .76
View the Response XML
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2019-02-07T15:52:45.246Z</u:Created>
            <u:Expires>2019-02-07T15:57:45.246Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <GeocodeAllMatchesResponse xmlns="http://tempuri.org/">
         <GeocodeAllMatchesResult xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:AddressLocation>
               <a:Alternate>0</a:Alternate>
               <a:CassAddress>
                  <a:Address xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                     <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                     <b:string>GREENWOOD VILLAGE, CO  80111-4905</b:string>
                  </a:Address>
                  <a:AddressLine>6465 GREENWOOD PLAZA BLVD</a:AddressLine>
                  <a:AddressQualityFlags>H3-nostat-+D</a:AddressQualityFlags>
                  <a:CarrierRoute>C023</a:CarrierRoute>
                  <a:City>GREENWOOD VILLAGE</a:City>
                  <a:CityStateZip>GREENWOOD VILLAGE, CO  80111-4905</a:CityStateZip>
                  <a:CountyCode>5</a:CountyCode>
                  <a:DeliveryPointValidation>33</a:DeliveryPointValidation>
                  <a:EnhancedLineOfTravel>0</a:EnhancedLineOfTravel>
                  <a:Reliability>103</a:Reliability>
                  <a:State>CO</a:State>
                  <a:USPSBarCode>/801114905993/</a:USPSBarCode>
                  <a:Zip>80111</a:Zip>
                  <a:Zip4>4905</a:Zip4>
               </a:CassAddress>
               <a:CensusBlockGroup>2022</a:CensusBlockGroup>
               <a:CensusTract>6712</a:CensusTract>
               <a:CityName>GREENWOOD VILLAGE</a:CityName>
               <a:Country>USA</a:Country>
               <a:County>Arapahoe</a:County>
               <a:ErrorMessage/>
               <a:FeatureID>2410661</a:FeatureID>
               <a:FipsCode>9900432152</a:FipsCode>
               <a:FipsPlaceName>Greenwood Village</a:FipsPlaceName>
               <a:Incorporated>true</a:Incorporated>
               <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                  <b:string>Denver,CO 80111</b:string>
               </a:InputAddress>
               <a:Latitude>39.599107918885792</a:Latitude>
               <a:Longitude>-104.894954777198</a:Longitude>
               <a:NetworkID>ta</a:NetworkID>
               <a:PCode>432152</a:PCode>
               <a:PostalCode>80111</a:PostalCode>
               <a:PostalCodeExtension>4905</a:PostalCodeExtension>
               <a:PrimaryJurisdictionName>GREENWOOD VILLAGE</a:PrimaryJurisdictionName>
               <a:PrimaryJurisdictionPCode>431200</a:PrimaryJurisdictionPCode>
               <a:Score>0.97</a:Score>
               <a:SecondaryUnit/>
               <a:SpecialTaxDistrictName>ARAPAHOE COUNTY RTD</a:SpecialTaxDistrictName>
               <a:SpecialTaxDistrictPCode>432152</a:SpecialTaxDistrictPCode>
               <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>6465 Greenwood Plaza Blvd</b:string>
                  <b:string>GREENWOOD VILLAGE,CO 80111-4905</b:string>
               </a:StandardizedAddress>
               <a:StateName>CO</a:StateName>
               <a:StreetName>Greenwood Plaza Blvd</a:StreetName>
               <a:StreetNumber>6465</a:StreetNumber>
               <a:TaxJurisdictionName>ARAPAHOE COUNTY RTD</a:TaxJurisdictionName>
               <a:TimeZone/>
               <a:UnderlyingFipsCode>800533035</a:UnderlyingFipsCode>
            </a:AddressLocation>
            <a:AddressLocation>
               <a:Alternate>0</a:Alternate>
               <a:CassAddress>
                  <a:Address xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                     <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                     <b:string>GREENWOOD VILLAGE, CO  80111-4905</b:string>
                  </a:Address>
                  <a:AddressLine>6465 GREENWOOD PLAZA BLVD</a:AddressLine>
                  <a:AddressQualityFlags>H3-nostat-+DR</a:AddressQualityFlags>
                  <a:CarrierRoute>C023</a:CarrierRoute>
                  <a:City>GREENWOOD VILLAGE</a:City>
                  <a:CityStateZip>GREENWOOD VILLAGE, CO  80111-4905</a:CityStateZip>
                  <a:CountyCode>5</a:CountyCode>
                  <a:DeliveryPointValidation>33</a:DeliveryPointValidation>
                  <a:EnhancedLineOfTravel>0</a:EnhancedLineOfTravel>
                  <a:Reliability>97</a:Reliability>
                  <a:State>CO</a:State>
                  <a:USPSBarCode>/801114905993/</a:USPSBarCode>
                  <a:Zip>80111</a:Zip>
                  <a:Zip4>4905</a:Zip4>
               </a:CassAddress>
               <a:CensusBlockGroup>2022</a:CensusBlockGroup>
               <a:CensusTract>6712</a:CensusTract>
               <a:CityName>CENTENNIAL</a:CityName>
               <a:Country>USA</a:Country>
               <a:County>ARAPAHOE</a:County>
               <a:ErrorMessage/>
               <a:FeatureID>2409422</a:FeatureID>
               <a:FipsCode>9900432152</a:FipsCode>
               <a:FipsPlaceName>CENTENNIAL</a:FipsPlaceName>
               <a:Incorporated>true</a:Incorporated>
               <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                  <b:string>Denver,CO 80111</b:string>
               </a:InputAddress>
               <a:Latitude>39.599219108437929</a:Latitude>
               <a:Longitude>-104.89498041358691</a:Longitude>
               <a:NetworkID>nt</a:NetworkID>
               <a:PCode>432152</a:PCode>
               <a:PostalCode>80111</a:PostalCode>
               <a:PostalCodeExtension>4905</a:PostalCodeExtension>
               <a:PrimaryJurisdictionName>CENTENNIAL</a:PrimaryJurisdictionName>
               <a:PrimaryJurisdictionPCode>432150</a:PrimaryJurisdictionPCode>
               <a:Score>0.75829380750656128</a:Score>
               <a:SecondaryUnit/>
               <a:SpecialTaxDistrictName>ARAPAHOE COUNTY RTD</a:SpecialTaxDistrictName>
               <a:SpecialTaxDistrictPCode>432152</a:SpecialTaxDistrictPCode>
               <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                  <b:string>CENTENNIAL,CO 80111-4905</b:string>
               </a:StandardizedAddress>
               <a:StateName>CO</a:StateName>
               <a:StreetName>GREENWOOD PLAZA BLVD</a:StreetName>
               <a:StreetNumber>6465</a:StreetNumber>
               <a:TaxJurisdictionName>ARAPAHOE COUNTY RTD</a:TaxJurisdictionName>
               <a:TimeZone/>
               <a:UnderlyingFipsCode>800512815</a:UnderlyingFipsCode>
            </a:AddressLocation>
         </GeocodeAllMatchesResult>
      </GeocodeAllMatchesResponse>
   </s:Body>
</s:Envelope>

GeocodeAllMatches Example 2 - Minimum Score

Using the same input address as Example 1, let’s change the minimum score (MinimumScore) to 0.8 to remove the second address result.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <o:UsernameToken>
            <o:Username>USERNAME</o:Username>
            <o:Password>PASSWORD</o:Password>
         </o:UsernameToken>
      </o:Security>
   </s:Header>
   <s:Body>
      <tem:GeocodeAllMatches>
         <tem:inputAddress xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:CassCertify>true</a:CassCertify>
            <a:City/>
            <a:CityStateZip>Denver,CO 80111</a:CityStateZip>
            <a:MinimumScore>0.8</a:MinimumScore>
            <a:Offset>3</a:Offset>
            <a:Options>312</a:Options>
            <a:SecondaryUnit/>
            <a:Source/>
            <a:State/>
            <a:StreetAddress>6465 Greenwood Plaza Blvd</a:StreetAddress>
            <a:Zip/>
         </tem:inputAddress>
         <tem:matchCount>10</tem:matchCount>
      </tem:GeocodeAllMatches>
   </s:Body>
</s:Envelope>

Response

The GeocodeAllMatchesResponse contains the same first address results as Example 1, but the second address has been removed because of the second address score (Score) of 0.76 is below the requested minimum score (MinimumScore) of 0.8.

View the Response XML
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2019-02-07T16:07:22.348Z</u:Created>
            <u:Expires>2019-02-07T16:12:22.348Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <GeocodeAllMatchesResponse xmlns="http://tempuri.org/">
         <GeocodeAllMatchesResult xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:AddressLocation>
               <a:Alternate>0</a:Alternate>
               <a:CassAddress>
                  <a:Address xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                     <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                     <b:string>GREENWOOD VILLAGE, CO  80111-4905</b:string>
                  </a:Address>
                  <a:AddressLine>6465 GREENWOOD PLAZA BLVD</a:AddressLine>
                  <a:AddressQualityFlags>H3-nostat-+DCR</a:AddressQualityFlags>
                  <a:CarrierRoute>C023</a:CarrierRoute>
                  <a:City>GREENWOOD VILLAGE</a:City>
                  <a:CityStateZip>GREENWOOD VILLAGE, CO  80111-4905</a:CityStateZip>
                  <a:CountyCode>5</a:CountyCode>
                  <a:DeliveryPointValidation>33</a:DeliveryPointValidation>
                  <a:EnhancedLineOfTravel>0</a:EnhancedLineOfTravel>
                  <a:Reliability>92</a:Reliability>
                  <a:State>CO</a:State>
                  <a:USPSBarCode>/801114905993/</a:USPSBarCode>
                  <a:Zip>80111</a:Zip>
                  <a:Zip4>4905</a:Zip4>
               </a:CassAddress>
               <a:CensusBlockGroup>2022</a:CensusBlockGroup>
               <a:CensusTract>6712</a:CensusTract>
               <a:CityName>GREENWOOD VILLAGE</a:CityName>
               <a:Country>USA</a:Country>
               <a:County>Arapahoe</a:County>
               <a:ErrorMessage/>
               <a:FeatureID>2410661</a:FeatureID>
               <a:FipsCode>9900432152</a:FipsCode>
               <a:FipsPlaceName>Greenwood Village</a:FipsPlaceName>
               <a:Incorporated>true</a:Incorporated>
               <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>6465 GREENWOOD PLAZA BLVD</b:string>
                  <b:string>Denver,CO 80111</b:string>
               </a:InputAddress>
               <a:Latitude>39.599107918885792</a:Latitude>
               <a:Longitude>-104.894954777198</a:Longitude>
               <a:NetworkID>ta</a:NetworkID>
               <a:PCode>432152</a:PCode>
               <a:PostalCode>80111</a:PostalCode>
               <a:PostalCodeExtension>4905</a:PostalCodeExtension>
               <a:PrimaryJurisdictionName>GREENWOOD VILLAGE</a:PrimaryJurisdictionName>
               <a:PrimaryJurisdictionPCode>431200</a:PrimaryJurisdictionPCode>
               <a:Score>0.97</a:Score>
               <a:SecondaryUnit/>
               <a:SpecialTaxDistrictName>ARAPAHOE COUNTY RTD</a:SpecialTaxDistrictName>
               <a:SpecialTaxDistrictPCode>432152</a:SpecialTaxDistrictPCode>
               <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>6465 Greenwood Plaza Blvd</b:string>
                  <b:string>GREENWOOD VILLAGE,CO 80111-4905</b:string>
               </a:StandardizedAddress>
               <a:StateName>CO</a:StateName>
               <a:StreetName>Greenwood Plaza Blvd</a:StreetName>
               <a:StreetNumber>6465</a:StreetNumber>
               <a:TaxJurisdictionName>ARAPAHOE COUNTY RTD</a:TaxJurisdictionName>
               <a:TimeZone/>
               <a:UnderlyingFipsCode>800533035</a:UnderlyingFipsCode>
            </a:AddressLocation>
         </GeocodeAllMatchesResult>
      </GeocodeAllMatchesResponse>
   </s:Body>
</s:Envelope>

See Also

Input

Results