the SOAP Guide PDF
Contents
1. Description The second part of a postcode For Canadian addresses this will be the LDU This field is not used by most countries Miscellaneous information that appears before the street name This field is not currently used A unique ID that identifies a street segment Indicates which side of the street has odd numbers L Left side of the street R Right side of the street B Both sides of the street U Undetermined The meaning of State Province varies by country CAN Canada Province The default search order rank of the database used to geocode the address A value of 1 indicates that the database is first in the default search order 2 indicates that the database is second in the default search order and so on The default database search order is specified in the Management Console with the Database Resources tool For most countries this contains the street name The type of street when the street type appears before the base street name The type of street when the street type appears after the base street name Street directional that follows the street name For example the N in 456 3rd St N The highest unit number of the range in which the unit resides The lowest unit number of the range in which the unit resides Geocoding Guide for Canada SOAP 36 Candidates returned by Spectrum geocoders return another class of return codes that are referred to as International Geocoding Result Co2. Only databases that have been defined in the Databases Resources panel in the Management Console are available DatabasePreference Specifies which geocoding databases to use One of the following PreferCustom Use both standard databases and custom databases but give preference to candidates from custom databases Use this option if you feel your Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 18 GeocodeAddressGlobal Parameter Description custom database is superior to the standard database PreferStandard Use both standard databases and custom databases but give preference to candidates from standard databases CustomOnly Use only custom databases Ignore standard databases StandardOnly Use only standard databases Ignore custom databases Both Use both standard databases and custom databases In cases where candidates are returned from both the standard database is preferred Default The results from a custom database have a U at the end of the result code Results from an address database have an A at the end of the match score For example SOSHPNTSCZA is a match score that comes from an address database while SSHPNTSCZU comes from a custom database For more information see Result Codes for International Geocoding on page 37 DatabaseSearchOrder The name of one or more database resources to use in the search process Use the database name specified in the Management Console s Databa
3. are demoted to non close matches You can also use the order of the databases to perform fallback processing if you have an both an address point database and a street level database installed for the country List the address point database first and the street database second If the address cannot be geocoded to the address point level the geocoder will attempt to geocode it to the street level Output Table 14 Reverse Geocode Address Global Output Fields Response Element Description AddressLine1 First line of the address AddressLine2 Second line of the address ApartmentLabel The type of unit such as apartment suite or lot ApartmentNumber Unit number City The municipality name County The meaning of county varies by country CAN Canada Not used Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 34 Response Element ReverseGeocodeAddressGlobal Description Distance FirmName Geocoder MatchCode HouseNumber HouseNumberHigh HouseNumberLow HouseNumberParity Language LastLine LeadingDirectional Locality NumberOfCandidateRanges NumberOfRangeUnits PostalCode The distance from input location in meters If the input coordinates are an exact match for the address the value is 0 Name of the company or a place name Indicates how closely the input coordinates match the candidate address For more information see Reverse Geocoding Codes R Codes on p
4. are used in every country Other single line formats may also be acceptable for many countries The matching accuracy for single line input is comparable to that of structured address input The performance of single line input addresses may be slightly slower than that of structured address input For best results use delimiters comma semicolon or colon between each address element For example 26 Wellington Street East Toronto ON M5E 1S2 If the input address is missing delimiters spaces are recognized as separators and internal parsing rules identify address elements In the example above the address would still successfully geocode even if some or all of the delimiters were missing in the input Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 7 GeocodeAddressGlobal Note Non delimited or partially delimited single line addresses may take longer to geocode and may not produce the same results as delimited single line input This is especially true for addresses with multi word street names or cities To optimize single line geocoding use delimiters between address elements particularly between street name and city Punctuation is ignored for geocoding purposes Guidelines for Single Line Input e For Canada ilf you omit the postal code and country the geocoder still geocodes the address based on street address city and province e Punctuation is generally ignored however you may improve re
5. of ranges of which the candidate is a member A candidate may be a part of multiple ranges if the candidate is a street instead of a building NumberOfRangeUnits Indicates the number of units included in the range A unit is an address within a building such as an apartment or office suite PostalCode The postcode for the address The format of the postcode varies by country Postcode data is not available for every country PostalCode Addon The second part of a postcode For Canadian addresses this will be the LDU This field is not used by most countries PreAddress Miscellaneous information that appears before the street name PrivateMailbox This field is not currently used Ranges This is a list field containing the address ranges that exist on the street segment where the candidate address is located A range is a series of addresses along a street segment For example 5400 5499 Main St is an address range representing addresses in the 5400 block of Main St A range may represent just odd or even addresses within a segment or both odd and even addresses A range may also represent a single building with multiple units such as an apartment building The Ranges field contains the following sub fields Address This is a list filed that contains sub fields for any address elements AddressLine1 City and so on that are different from the candidate s address AdditionalFields A listing of country specific information related
6. of unit such as apartment suite or lot Unit number The municipality name The three letter ISO 3166 1 Alpha 3 country code For Canada the country code is CAN Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address For example Vatican City addresses return VAT in the Country field regardless of whether VAT or ITA Italy was passed as the country code Similarly addresses in Martinique return MTQ rather than FRA in the Country field The meaning of county varies by country CAN Canada Not used Name of the company or a place name The building number for the matched location The highest house number of the range in which the address resides The lowest house number of the range in which the address resides Indicates if the house number range contains even or odd numbers or both E Even O Odd B Both U Unknown For reverse geocoded candidates the two character language code is returned Complete last address line city state province and postal code Geocoding Guide for Canada SOAP 21 GeocodeAddressGlobal Response Element Description LeadingDirectional Street directional that precedes the street name For example the N in 138 N Main Street Locality The meaning of locality varies by country CAN Canada Dissemination Area and Enumeration Area DA and EA NumberOfCandidateRanges Indicates the number
7. to geocode addresses to a street address but some matches may end up at a less precise location such as a postal code centroid intersection or shape path PostalCentroid If postal code data is available the geocoder attempts to geocode addresses to the most precise postal code it finds The advantage of postal code centroid matching is the speed of the operation The disadvantage of postal code matching is that the geocoder only examines the PostalCode field If you use street address precision the geocoder looks at both the street name and the PostalCode field and attempts to return street level coordinates and optionally fall back to postal code coordinates GeographicCentroid The geocoder attempts to geocode addresses to the geographic centroid of a city or state Interpolation Specifies whether to perform address point interpolation This option only works if you have a point database installed This option is available for selected countries only Address point interpolation uses point data to refine geocode results By default the geocoding process estimates the location of an address based on the street numbers at either end of street segment For example if a street segment runs from 100 Main St to 200 Main St then a request for 150 Main St will return a location in the middle of the segment With interpolation the geocoder finds the position of 180 Main St in the point data and it is about two thirds of the way
8. Parameter Description SearchDistance The radius from the input coordinates in which to search for an address Street segments and points within the radius are considered The default search radius is 150 meters and the maximum search radius is 1600 meters Units The units in which the search distance is specified One of the following Feet Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 30 ReverseGeocodeAddressGlobal Parameter Description e Miles e Meters e Kilometers OffsetFromStreet Indicates the offset distance from the street segments to use in street level geocoding The distance is specified in the units you specify in the OffsetUnits option The default value varies by country For most countries the default is 7 meters The offset distance is used in street level geocoding to prevent the geocode from being in the middle of a street It compensates for the fact that street level geocoding returns a latitude and longitude point in the center of the street where the address is located Since the building represented by an address is not on the street itself you do not want the geocode for an address to be a point on the street Instead you want the geocode to represent the location of the building which sits next to the street For example an offset of 50 feet means that the geocode will represent a point 50 feet back from the center of the street The distance is calculated perpendicular
9. Using types is not essential but it adds precision to your data For a list of valid street types see www canadapost com e City name Do not abbreviate city names If the city is unknown you may leave it blank although this may affect the accuracy of the geocode e Province name You may use the full province name for example Ontario but using the two character abbreviation ON is recommended to reduce the likelihood of input errors Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP GeocodeAddressGlobal Single Line Input Instead of entering each address element in separate fields you may enter the entire address in the AddressLine1 input field For all countries except Japan you can enter addresses in one or more of these single line formats Note Not all formats work may work for every country StreetAddress PostalCode City StreetAddress City PostalCode StreetAddress City StreetAddress City StateProvince PostalCode StreetAddress Locality StreetAddress County City PostalCode StreetAddress PostalCode StreetAddress City City PostalCode StreetAddress Where e StreetAddress can be house number and street name in either order with street type immediately before or after the street name e City is the city or town e StateProvince is the postal abbreviation for the state or province PostalCode is the complete postcode For Brazil Note Not all of these address elements
10. age 41 The building number for the matched location The highest house number of the range in which the address resides The lowest house number of the range in which the address resides Indicates if the house number range contains even or odd numbers or both E Even O Odd B Both U Unknown For reverse geocoded candidates the two character language code is returned Complete last address line city state province and postal code Street directional that precedes the street name For example the N in 138 N Main Street The meaning of locality varies by country e CAN Canada Dissemination Area and Enumeration Area DA and EA Indicates the number of ranges of which the candidate is a member A candidate may be a part of multiple ranges if the candidate is a street instead of a building Indicates the number of units included in the range A unit is an address within a building such as an apartment or office suite The postcode for the address The format of the postcode varies by country Postcode data is not available for every country Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 35 Response Element PostalCode Addon PreAddress PrivateMailbox SegmentCode SegmentParity StateProvince StreetDataType StreetName StreetPrefix StreetSuffix TrailingDirectional UnitNumberHigh UnitNumberLow Spectrum Technology Platform 10 0 ReverseGeocodeAddressGlobal
11. ate address Interpolated street address Street segment midpoint Postal code 1 centroid Partial postal code 2 centroid Postal code 2 centroid ona fF wWN Intersection Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 26 Response Element Description 8 9 10 11 12 15 LocationPrecision codes 13 14 15 16 17 StreetDataType GeocodeAddressGlobal Point of interest This is a placeholder value Spectrum databases do not have POI data so it is not possible to get this return State province centroid County centroid City centroid Locality centroid For most countries LocationPrecision codes 12 through 15 are reserved for unspecified custom items Additional point precision for unspecified custom item Additional point precision for unspecified custom item Additional point precision for unspecified custom item The result is an address point The result was generated by using address point data to modify the candidates segment data The result is an address point that was projected using the centerline offset feature You must have both a point and a street range database to use the centerline offset feature and thereby return LocationPrecision 18 The default search order rank of the database used to geocode the address A value of 1 indicates that the database is first in the default search order 2 indicates that the database is second in the default s
12. ates For example if there are 10 candidates and two of them are close candidates and you enable this option only the two close matching candidates would be returned instead of all 10 To specify what is considered a close match use the options Address candidates are ranked according to how closely the input address matches these preferences Y Yes return only close matches N No do not return only close matches Default MatchMode Specifies how to determine whether a candidate is a close match One of the following CustomMode This option allows you to specify which parts of a candidate address must match the input address to be considered a close match Use the to specify the address elements you want This is the default value for most countries ExactMode All of a candidate address s elements must match in order for the candidate to be considered a close match Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 14 GeocodeAddressGlobal Parameter Description CloseMode Only the candidate address s house number must match in order for the candidate to be considered a close match For Chile China Great Britain Estonia India Indonesia Latvia Lithuania Slovakia Slovenia Taiwan and South Africa only the street name and town must match RelaxedMode All candidate addresses are considered a close match MustMatchinput Specifies whether candidates must match all non blank input fields to be co
13. containing the street name and building number For example 330 Main St Toronto ON M1B 3V4 e This field can also contain the full address For more information see Single Line Input on page 7 e For all countries except Argentina Great Britain and Japan this field can contain a street intersection To specify a street intersection use double ampersand amp amp to separate the streets For more information see Street Intersection Input on page 8 AddressLine2 The second address line of a two line address For example Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 4 Parameter GeocodeAddressGlobal Description FirmName HouseNumber LastLine Locality PostalCode StateProvince 26 WELLINGTON ST E SUITE 500 TORONTO ON M5E 1S2 The city or town name Your input address should use the official city name The meaning of county varies by country CAN Canada Not used Company or place name For example Toronto Star Building 1 Yonge St Toronto ON M5E 1E5 The building number You may get better parsing results for some countries if you put the house number in this field instead of AddressLine1 Not every country includes house number data Note The house number specified in the HouseNumber field takes precedence over any house number specified in the AddressLine1 field The last line of the address e 330 Main St Toronto ON M1B 3V4 The meaning of locality varie
14. d how the input address was parsed and identify specific input elements that could not be geocoded For example a returned HouseNumber nput could contain an invalid house number in your input address Note Data vintage must be 2014 Q4 or newer to get Parsed Address Input returns Also note that Parsed Address Input elements are not returned for every country Parsed Address Input elements are returned in separately labeled fields names with a Input extension For example FormattedInputStreet Input e City Input e Country Input e HouseNumber Input e Locality Input e PostalCode Base Input e StreetName Input e StreetSuffix Input Other labeled fields are possible depending on the input address country and data source Note Parsed Address Input elements are not returned for every country Also because Geocode Address World geocodes to the geographic or postal level only not street address this does not return Parsed Address Input Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 12 GeocodeAddressGlobal Parameter Description For many countries if part of the input address could not be recognized as a specific address element this content is returned in UnparsedWords Input For intersection addresses the first entered street is returned in StreetName Input and the second entered street name is returned in IntersectionStreet2 Input Matching Options Matching options let you
15. deAddressGlobal determines the address for a given latitude longitude point ReverseGeocodeAddressGlobal can determine addresses in many countries The countries available to you depends on which country databases you have installed For example if you have databases for Canada Italy and Australia installed ReverseGeocodeAddressGlobal would be able to geocode addresses in these countries in a single stage Note ReverseGeocodeAddressGlobal does not support U S addresses To geocode U S addresses use ReverseGeocodeUSLocation Before you can work with ReverseGeocodeAddressGlobal you must define a global database resource containing a database for one or more countries Once you create the database resource a ReverseGeocodeAddressGlobal will become available in the Management Console Enterprise Designer and Interactive Driver In this section Input 30 Options 30 Output 34 ReverseGeocodeAddressGlobal Input ReverseGeocodeAddressGlobal takes longitude and latitude as input Table 10 ReverseGeocodeGlobal Input Parameter Format Description The latitude of the point for which you want address information The longitude of the point for which you want address information One of the following e The name of the country in English The two character ISO 3116 1 alpha 2 country code The three character ISO 3116 1 alpha 3 country code Options Geocoding Options Table 11 Geocoding Options for Canada
16. des Each attempted match returns a result code in the Geocoder MatchCode output field International Street Geocoding Result Codes S Codes 38 Interpreting S Result Codes 39 International Postal Geocoding Result Codes Z Codes 40 International Geographic Geocoding Result Codes G Codes 40 Reverse Geocoding Codes R Codes 41 Non match Codes 41 Result Codes for International Geocoding International Street Geocoding Result Codes S Codes Street level geocoded candidates return a result code beginning with the letter S The second character in the code indicates the positional accuracy of the resulting point for the geocoded record Table 15 Street S Result Codes S Result Code Description Single close match with the point located at postal code centroid For Canada this is an FSA centroid Single close match with the point located at postal code centroid For Canada this is an FSALDU centroid Single close match with the point located at the street centroid For databases vintage 2014 Q4 or newer the input house number is returned with the candidate even if no such house number was found The S4 code is followed by letters and dashes indicating match precision See Interpreting S Result Codes on page 39 Single close match with the point located at a street address position The S5 code is followed by letters and dashes indicating match precision For information about these letters see Interpreting S Result Cod
17. down the street Using this information the geocoder can estimate the position of 150 Main St based on 100 and 180 Main St In this case the geocoder estimates the location of the address slightly away from the center of the segment Y Yes perform address point interpolation N No do not perform address point interpolation Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 9 GeocodeAddressGlobal Parameter Description FallbackToGeographic Specifies whether to attempt to determine a geographic region centroid when an address level geocode cannot be determined Y Yes determine a geographic centroid when an address level centroid cannot be determined Default N No do not determine a geographic centroid when an address level centroid cannot be determined FallbackToPostal Specifies whether to attempt to determine a postal code centroid when an address level geocode cannot be determined Y Yes determine a postal code centroid when an address level centroid cannot be determined Default N No do not determine a postal code centroid when an address level centroid cannot be determined OffsetFromStreet Indicates the offset distance from the street segments to use in street level geocoding The distance is specified in the units you specify in the OffsetUnits option The default value varies by country For most countries the default is 7 meters The offset distance is used in street level geocoding
18. e a global database resource containing a database for one or more countries Once you create the database resource a GeocodeAddressGlobal will become available in the Management Console Enterprise Designer and Interactive Driver GeocodeAddressGlobal is an optional component of the Enterprise Geocoding Module Input 4 Options 8 Output 20 GeocodeAddressGlobal Input GeocodeAddressGlobal takes an address or intersection as input To obtain the best performance and the most possible matches your input address lists should be as complete as possible free of misspellings and incomplete addresses and as close to postal authority standards as possible Most postal authorities have websites that contain information about address standards for their particular country Input Fields To obtain the best performance and the most possible matches your input address lists should be as complete as possible free of misspellings and incomplete addresses and as close to postal authority standards as possible Most postal authorities have websites that contain information about address standards for their particular country NAVTEQ data is available for Canada For NAVTEQ data note the following Data 1987 2015 HERE All rights reserved The following table lists the input fields used for geocoding locations in Canada Table 1 Input Fields for Canada Parameter Description AddressLine1 One of the following The address line
19. earch order and so on The default database search order is specified in the Management Console with the Database Resources tool Country Specific Output The following topics describe output that s unique to specific countries Canada Specific Output The following table lists output fields that are unique to Canada Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 27 GeocodeAddressGlobal Table 9 Canada Specific Output Response Element Description CAN Census_CD The Census Division CD in which the address is located For more information see the Census Division definition available on the Statistics Canada website CAN Census_CMA The Census Metropolitan Area CMA in which the address is located For more information see the Census Metropolitan Area definition on the Statistics Canada website CAN Census_CSD The Census Subdivision CSD in which the address is located For more information see the Census Subdivision definition on the Statistics Canada website CAN Census_CT The Census Tract CT in which the address is located For more information see the Census Tract definition on the Statistics Canada website CAN Census_DA The Dissemination Area DA in which the address is located For more information see the Dissemination Area definition available on the Statistics Canada website Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 28 ReverseGeoco
20. es on page 39 Single match with the point located at an interpolated point along the candidate s street segment When the potential candidate is not an address point candidate and there are no exact house number matches among other address point candidates the S7 result is returned using address point interpolation The point is interpolated according to the next highest or lowest address point candidate that both intersects the segment and whose house number is contained within the range of houses of the original candidate By using known address reference points on the street segment the S7 point can be adjusted to a more accurate position Single close match with the point located at either the single point associated with an address point candidate or at an address point candidate that shares the same house number No interpolation is required S8 returns are possible with point databases only Single close match with the point located at street intersection Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 38 Result Codes for International Geocoding Interpreting S Result Codes For S street geocoded international result codes eight additional characters describe how closely the address matches an address in the database The characters appear in the order listed in the following table Any non matched address elements are represented by a dash For example the result code S5 N SCZA represents a sing
21. es the match rate If the geocoding database is indexed the performance impact is reduced Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 15 GeocodeAddressGlobal Parameter Description Y Yes a candidate must match the street name to be considered a close match N No a candidate does not have to match the street name to be considered a close match MustMatchLocality If you do not require exact matches on locality the geocoder searches on the street address matched to the particular postal code and considers other localities that do not match the name but do match the postal code CAN Canada Dissemination Area and Enumeration Area DA and EA Y Yes a candidate must match the locality to be considered a close match N No a candidate does not have to match the locality to be considered a close match MustMatchCity Specifies whether candidates must match the city to be considered a close match For Japan this field specifies whether the candidate must match the municipality subdivision oaza If you do not require exact matches on city the geocoder searches on the street address matched to the particular postal code and considers other cities that do not match the name but do match the postal code Y Yes a candidate must match the city to be considered a close match N No a candidate does not have to match the city to be considered a close match MustMatchCounty Specifies whethe
22. fault is Meters A coordinate system is a reference system for the unique location of a point in space Cartesian planar and Geodetic geographical coordinates are examples of reference systems based on Euclidean geometry Spectrum Technology Platform supports systems recognized by the European Petroleum Survey Group EPSG Each country supports different coordinate systems Depending on the country you have one or more of the following options EPSG 4326 Also known as the WGS84 coordinate system Also known as the NZGD49 coordinate system EPSG 27200 Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 32 ReverseGeocodeAddressGlobal Matching Options Table 12 Matching Options for Canada Parameter Description KeepMultimatch Specifies whether to return results when the coordinates match to multiple candidate addresses in the database If this option is not selected coordinates that results in multiple address candidates will fail to geocode If you select this option specify the maximum number of candidates to return using the MaxCandidates option see below Y Yes return candidates when multiple candidates are found Default N No do not return candidates Addresses that result in multiple candidates will fail to geocode SortCandidatesUsingLocale This is a Reverse geocoding option that applies to Greece Russia Ukraine and any other country that supports dual character sets such as
23. her a candidate address must have a full postal code FSA and LDU to be considered a close match Canadian postal codes are divided into two sections the Forward Sortation Area FSA and the Local Delivery Unit LDU For example the postal code M6H 2P8 has an FSA of M6H and an LDU of 2P8 Some candidate addresses may contain only the FSA This option allows you to prevent such addresses from being classified a close match Y Yes the candidate address must contain a full postal code to be considered a close match N No the candidate address does not have to contain a full postal code to be considered a close match Default SortCandidatesUsingLocale This is a Reverse geocoding option that applies to Greece Russia Ukraine and any other country that supports dual character sets such as the Middle East countries Specifies whether candidates are sorted and returned based on the input language That is if the input was in Russian the Russian character candidate is returned first followed by the English language candidate This will override the dictionary order Y Yes candidates are sorted and returned based on input language Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 17 GeocodeAddressGlobal Parameter Description N No candidates are returned in the order that the dictionary was added to the database regardless of input language You may want to use a balanced strategy between match ra
24. le close match that matched the street name street suffix direction town and postcode The dashes indicate that there was no match on house number street prefix direction or thoroughfare type The match came from the Street Range Address database This record would be geocoded at the street address position of the match candidate Description Example H House number 18 P Street prefix direction North P is present if any of these conditions are satisfied The candidate pre directional matches the input pre directional The candidate post directional matches the input pre directional after pre and post directionals are swapped The input does not have a pre directional N Street name Merivale T Street type St S Street suffix direction W S in result code is present if any of these conditions are satisfied e The candidate post directional matches the input post directional The candidate pre directional matches the input post directional after pre and post directionals are swapped The input does not have a post directional C City name South Brisbane Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 39 Result Codes for International Geocoding Description Example Postal code Database type used to obtain the match e A Street Range Address database e U Customer user defined database International Postal Geocoding Result Codes Z Codes Matches in the Z ca
25. ned field for each input address element Parsed Address Input elements are returned in separately labeled fields names with a Input extension See the Return Parsed Address Geocoding Option for more information Geocoding Guide for Canada SOAP 24 GeocodeAddressGlobal Geocode Output Table 7 Geocode Output for Canada Response Element Description CoordinateSystem The coordinate system used to determine the latitude and longitude coordinates A coordinate system specifies a map projection coordinate units etc An example is EPSG 4326 EPSG stands for European Petroleum Survey Group Seven digit number in degrees and calculated to four decimal places in the format specified Seven digit number in degrees and calculated to four decimal places in the format specified Result Codes Result codes contain information about the success or failure of the geocoding attempt as well as information about the accuracy of the geocode Table 8 Result Code Output for Canada Response Element Description Geocoder MatchCode Indicates how closely the input address matches the candidate address For more information see Result Codes for International Geocoding on page 37 IsCloseMatch Indicates whether or not the address is considered a close match An address is considered close based on the Close match criteria options on the Matching tab Y Yes the address is a close match N No the address is not a close match Mul
26. nsidered a close match For example if an input address contains a city and postal code then candidates for this address must match the city and postal code to be considered a close match Y Yes a candidate must match all input to be considered a close match N No a candidate does not have to match all input to be considered a close match Default MustMatchHouseNumber Specifies whether candidates must match the house number to be considered a close match If you select this option you should also require an exact match on street name This option does not significantly affect performance It does however affect the type of match if the candidate address corresponds to a segment that does not contain any ranges The type of match can also be affected when the house number range for a candidate does not contain the input house number If you relax the house number you should set the maximum ranges to be returned to a value higher than 0 Y Yes a candidate must match the house number to be considered a close match N No a candidate does not have to match the house number to be considered a close match MustMatchStreet Specifies whether candidates must match the street name to be considered a close match If a close match is found the geocoder attempts expanded street name manipulation which looks for candidates with names that sound like the input address or that are spelled improperly This slows down performance but increas
27. ova Marketing Group Inc Portions of this program are Copyright 1993 2007 by Nova Marketing Group Inc All Rights Reserved Copyright Second Decimal LLC Copyright Canada Post Corporation This CD ROM contains data from a compilation in which Canada Post Corporation is the copyright owner 2007 Claritas Inc The Geocode Address World data set contains data licensed from the GeoNames Project www geonames org provided under the Creative Commons Attribution License Attribution Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 44 Copyright License located at http creativecommons org licenses by 3 0 legalcode Your use of the GeoNames data described in the Spectrum Technology Platform User Manual is governed by the terms of the Attribution License and any conflict between your agreement with Pitney Bowes Software Inc and the Attribution License will be resolved in favor of the Attribution License solely as it relates to your use of the GeoNames data ICU Notices Copyright 1995 2011 International Business Machines Corporation and others All rights reserved Permission is hereby granted free of charge to any person obtaining a copy of this software and associated documentation files the Software to deal in the Software without restriction including without limitation the rights to use copy modify merge publish distribute and or sell copies of the Software and to permit pe
28. pitney bowes Spectrum Technology Platform Version 10 0 Geocoding Guide for Canada SOAP Table of Contents 1 GeocodeAddressGlobal Input 4 Options 8 Output 20 Fe ReverseGeocodeAddressGlobal Input 30 Options 30 Output 34 3 Result Codes for International Geocoding International Street Geocoding Result Codes S Codes 38 Interpreting S Result Codes 39 International Postal Geocoding Result Codes Z Codes 40 International Geographic Geocoding Result Codes G Codes 40 Reverse Geocoding Codes R Codes 41 Non match Codes 41 GeocodeAddressGlobal provides street level geocoding for many countries It can also determine city or locality centroids as well as postal code centroids GeocodeAddressGlobal handles street addresses in the native language and format For example a typical French formatted address might have a street name of Rue des Remparts A typical German formatted address could have a street name Bahnhofstrasse Note GeocodeAddressGlobal does not support U S or U K addresses To geocode U S addresses use GeocodeUSAddress To geocode U K addresses use GeocodeAddressGBR The countries available to you depends on which country databases you have installed For example if you have databases for Canada Italy and Australia installed GeocodeAddressGlobal would be able to geocode addresses in these countries in a single stage Before you can work with GeocodeAddressGlobal you must defin
29. put firm name must match the firm name in the database exactly Some differences in abbreviations are considered similar enough to result in the firm name being returned Y Yes return only firm names that are similar to the input firm name N No return firm names regardless of whether they are close to the input firm name Default Output The geocoder returns the latitude longitude standardized address and result indicators Result indicators describe how well the geocoder matched the input address to a Known address and assigned a location they also describe the overall status of a match attempt If you are using the API t T he output returned is in the DataTable class For information on the DataTable class see the API Fundamentals section of the Address Output The address may be identical to the input address if the input address was accurate or it may be a standardized version of the input address or it may be a candidate address when multiple matches are found Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 20 GeocodeAddressGlobal Table 6 Address Output for Canada Response Element Description AddressLine1 AddressLine2 ApartmentLabel ApartmentNumber City Country County FirmName HouseNumber HouseNumberHigh HouseNumberLow HouseNumberParity Language LastLine Spectrum Technology Platform 10 0 First line of the address Second line of the address The type
30. r candidates must match the county or equivalent to be considered a close match The meaning of county varies for different countries CAN Canada Not used One of the following Y Yes a candidate must match the county to be considered a close match N No a candidate does not have to match the county to be considered a close match MustMatchStateProvince Specifies whether candidates must match the state or province or equivalent to be considered a close match CAN Canada Province Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 16 GeocodeAddressGlobal Parameter Description One of the following Y Yes a candidate must match the state or province to be considered a close match N No a candidate does not have to match the state or province to be considered a close match MustMatchPostalCode Specifies whether candidates must match the postal code to be considered a close match If you do not require exact match on postal codes the geocoder searches a wider area for a match While this results in slower performance the match rate is higher because the request does not need to match exactly when it compares match candidates Y Yes a candidate must match the postal code to be considered a close match N No a candidate does not have to match the postal code to be considered a close match MustMatchFullPostalCode This option applies only to Canadian addresses Specifies whet
31. rsons to whom the Software is furnished to do so provided that the above copyright notice s and this permission notice appear in all copies of the Software and that both the above copyright notice s and this permission notice appear in supporting documentation THE SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS INNO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE DATA OR PROFITS WHETHER IN AN ACTION OF CONTRACT NEGLIGENCE OR OTHER TORTIOUS ACTION ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE Except as contained in this notice the name of a copyright holder shall not be used in advertising or otherwise to promote the sale use or other dealings in this Software without prior written authorization of the copyright holder el Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 45
32. s a series of addresses along a street segment For example 5400 5499 Main St is an address range representing addresses in Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 13 GeocodeAddressGlobal Parameter Description the 5400 block of Main St A range may represent just odd or even addresses within a segment or both odd and even addresses A range may also represent a single building with multiple units such as an apartment building Y Yes return address range information N No do not return address range information Default MaxRanges If you choose to return ranges this option specifies the maximum number of ranges to return for each candidate Since the geocoder returns one candidate per segment and since a segment may contain multiple ranges this option allows you to see the other ranges in a candidate s segment MaxRangeUnits If you choose to return ranges this option specifies the maximum number of units for example apartments or suites to return for each range For example if you were to geocode an office building at 65 Main St containing four suites there would be a maximum of four units returned for the building s range 65 Suite 1 65 Suite 2 65 Suite 3 and 65 Suite 4 If you were to specify a maximum number of units as 2 then only two units would be returned instead of all four CloseMatchesOnly Specifies whether to return only those geocoded results that are close match candid
33. s by country CAN Canada Dissemination Area and Enumeration Area DA and EA The postal code in the appropriate format for the country Canada uses a six character postal code The first three characters are typically separated from the second three with a space The first three characters are the FSA the second three are the LDU Street address geocoding only requires the FSA while postal code geocoding requires the full postal code FSALDU Choose whether you wish to have a space between the first three and last three characters of the postal code Keeping this consistent speeds up the geocoding process The meaning of State Province varies by country Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP GeocodeAddressGlobal Parameter Description CAN Canada Province Address Input Guidelines Follow these suggestions to ensure that your street input data is in the best format possible for optimal geocoding Address Guidelines for Canada Follow these suggestions to ensure that your street input data is in the best format possible for optimum geocoding e Post Office Box numbers P O Boxes and Rural Route addresses are not geocodable GeocodeAddressCAN will honor this user input and attempt to output Boxes and Rural Route information but it will not be used for geocoding purposes Highway addresses Highway addresses such as Hwy 401 are geocoded House numbers and apartment le
34. s on optical and magnetic media The following trademarks are owned by the United States Postal Service CASS CASS Certified DPV eLOT FASTforward First Class Mail Intelligent Mail Laca NCoaH K PAVE PLANET Code Postal Service POSTNET Post Office RDI Suite United States Postal Service Standard Mail United States Post Office USPS ZIP Code and ZIP 4 This list is not exhaustive of the trademarks belonging to the Postal Service Pitney Bowes Inc is a non exclusive licensee of USPS for NCOAH processing Prices for Pitney Bowes Software s products options and services are not established controlled or approved by USPS or United States Government When utilizing RDI data to determine parcel shipping costs the business decision on which parcel delivery company to use is not made by the USPS or United States Government Data Provider and Related Notices Data Products contained on this media and used within Pitney Bowes Software applications are protected by various trademarks and by one or more of the following copyrights Copyright United States Postal Service All rights reserved 2014 TomTom All rights reserved TomTom and the TomTom logo are registered trademarks of TomTom N V 1987 2014 HERE All rights reserved Fuente INEGI Instituto Nacional de Estadistica y Geografia Based upon electronic data National Land Survey Sweden Copyright United States Census Bureau Copyright N
35. se Resources tool You can specify multiple database resources If you specify more than one database list them in order of preference The order of the databases has an effect when there are close match candidates from different databases The close matches that are returned come from the database that is first in the search list Close matches from lower ranked databases are demoted to non close matches You can also use the order of the databases to perform fallback processing if you have an both an address point database and a street level database installed for the country List the address point database first and the street database second If the address cannot be geocoded to the address point level the geocoder will attempt to geocode it to the street level Related Links GeocodeAddressGlobal on page 3 Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 19 GeocodeAddressGlobal Output Data Options The following table lists the options that control which data is returned in the output Table 5 Output Data Options Parameter Description ReturnOnlySimilarFirmmNames This option applies to the U K only Specifies whether to return firm names only when the input firm name is similar to the firm name in the geocoding database For example if the input firm name is Pitney Bowes but the geocoding database returns Pitney Bowes Software Inc these two firm names are not similar In most cases the in
36. set match restrictions fallback and multiple match settings so that the matching can be as strict or relaxed as you need The strictest matching conditions require an exact match on house number street name postal code and no fallback to postal code centroids The geocoder looks for an exact street address match within the postal code in the input address Relaxing the conditions broadens the area in which it searches for a match For example by relaxing the postal code the geocoder searches for candidates outside the postal code but within the city of your input address Table 3 Matching Options for Canada Parameter Description KeepMultimatch Specifies whether to return results when the address matches to multiple candidates in the database If this option is not selected an address that results in multiple candidates will fail to geocode If you select this option specify the maximum number of candidates to return Y Yes return candidates when multiple candidates are found Default N No do not return candidates Addresses that result in multiple candidates will fail to geocode MaxCandidates If you specify KeepMultimatch Y this option specifies the maximum number of results to return The default is 1 Specify 1 minus one to return all possible candidates ReturnRanges Specifies whether to return address range information If you enable this option the output field Ranges will be included in the output A range i
37. sults and performance by using separators commas semicolons etc between different address elements e The country is not required Each country geocoder assumes that the address is in its country e Firm information placename building name or government building is returned if available Street Intersection Input If you enter a street intersection as input the geocoder will provide the coordinates of the intersection To enter an intersection specify the two street names separated by a double ampersand amp amp in AddressLine1 For some countries the word AND can also be used to delimit intersections The amp amp delimiter can be used for all countries For example AddressLine1 Yonge amp amp Wellington City Toronto Note The double ampersand amp amp can always be used as an street intersection separator For some countries you can use additional symbols or words to delimit street intersections All close match criteria are enforced for intersection geocoding just as for any street level geocoding Options Geocoding Options The following table lists the options that control how a location s coordinates are determined eS Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 8 GeocodeAddressGlobal Table 2 Geocoding Options for Canada Parameter Description GeocodeLevel Specifies how precisely you want to geocode addresses One of the following StreetAddress The geocoder attempts
38. supported for the United Kingdom GBR or Japan JPN The default value varies by country 12 meters Australia AUS Austria AUT Germany DEU 7 meters For other supported countries the default offset is 7 meters The following diagram compares the end points of a street to offset end points Solel Go Street Segment End With Corner Offset Street Segment End OffsetUnits Specifies the unit of measurement for the street offset and corner offset options One of the following Feet e Miles Meters e Kilometers Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 11 GeocodeAddressGlobal Parameter Description The default is Meters CoordinateSystem A coordinate system is a reference system for the unique location of a point in space Cartesian planar and Geodetic geographical coordinates are examples of reference systems based on Euclidean geometry Spectrum Technology Platform supports systems recognized by the European Petroleum Survey Group EPSG Each country supports different coordinate systems Depending on the country you have one or more of the following options EPSG 4326 Also known as the WGS84 coordinate system EPSG 27200 Also known as the NZGD49 coordinate system Includelnputs Specifies whether to return the formatted input street address and each input address element in a separate field This feature can help you understan
39. te and geographic precision That is you may want to geocode as many records as possible automatically but at the same time want to minimize the number of weaker matches false positives For example false positives can occur when the geocoder e finds a street that sounds like the input street e finds the same street in another city if postal code match is not required e finds the street but with a different house number if house number is not required The following settings may achieve a good balance between match rate and precision e CloseMatchesOnly Specify Y MustMatchHouseNumber Specify Y e MustMatchStreet Specify Y FallbackToPostal Specify N Data Options The Data tab allows you to specify which databases to use in geocoding Databases contain the address and geocode data necessary to determine the geocode for a given address There are two kinds of databases standard databases and custom databases Standard databases are those supplied by Pitney Bowes and based on address and geocoding data from postal authorities and suppliers of geographical data Custom databases are databases you create to enhance or augment standard databases for your particular needs The following table lists the options available for specifying which databases to use and the search order of databases Table 4 Data Options for Canada Parameter Description Database Specifies the database to be used for geocoding
40. tegory indicate that a match was made at the postcode level A postcode match is returned in either of these cases e You specified to match to postal code centroids The resulting point is located at the postal code centroid with the following possible accuracy levels e There is no street level close match and you specified to fall back to postal code centroid Table 16 Postal Z Result Codes Z Result Code Description Postal Code centroid match Full postal code centroid match For Canada this is an FSALDU centroid Postal level geocoded candidates return a result code beginning with the letter Z Canada can generate a Z1 result code Country specific geocoders can often generate more accurate postcode results with Z2 or Z3 result codes International Geographic Geocoding Result Codes G Codes Geographic level geocoded candidates return a result code beginning with the letter G The numbers following the G in the result code provides more detailed information on the accuracy of the candidate Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 40 Result Codes for International Geocoding Table 17 Geographic G Result Codes G Result Code Description State or province centroid match County district or region centroid match City or town municipality centroid match Locality village suburb or neighborhood centroid match Reverse Geocoding Codes R Codes Matches in the R categor
41. the Middle East countries Specifies whether candidates are sorted and returned based on the input language That is if the input was in Russian the Russian character candidate is returned first followed by the English language candidate This will override the dictionary order Y Yes candidates are sorted and returned based on input language N No candidates are returned in the order that the dictionary was added to the database regardless of input language Data Options The Data tab allows you to specify which databases to use in reverse geocoding Databases contain the address and geocode data necessary to determine the address for a given point The following table lists the options available for specifying the search order of databases Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 33 ReverseGeocodeAddressGlobal Table 13 Data Options for Canada Parameter Description DatabaseSearchOrder The name of one or more database resources to use in the search process Use the database name specified in the Management Console s Database Resources tool You can specify multiple database resources If you specify more than one database list them in order of preference The order of the databases has an effect when there are close match candidates from different databases The close matches that are returned come from the database that is first in the search list Close matches from lower ranked databases
42. tiMatchCount For street address geocoding the number of matching address positions found for the specified address For intersection geocoding the number of matching street intersection positions found for the specified addresses Status Reports the success or failure of the match attempt Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 25 GeocodeAddressGlobal Response Element Description null Success F Failure Status Code If the geocoder could not process the address this field will show the reason e Internal System Error No Geocode Found e Insufficient Input Data e Multiple Matches Found e Exception occurred e Unable to initialize Geocoder e No Match Found Status Description If the geocoder could not process the address this field will show a description of the failure Problem explanation Returned when Status Code Internal System Error Geocoding Failed Returned when Status Code No Geocode Found No location returned Returned when Status Code No Geocode Found No Candidates Returned The geocoder could not identify any candidate matches for the address Multiple Candidates The address resulted in multiple Returned and Keep candidates In order for the candidate Multiple Matches not address to be returned you must selected LocationPrecision A code describing the precision of the geocode One of the following 0 No coordinate information is available for this candid
43. to prevent the geocode from being in the middle of a street It compensates for the fact that street level geocoding returns a latitude and longitude point in the center of the street where the address is located Since the building represented by an address is not on the street itself you do not want the geocode for an address to be a point on the street Instead you want the geocode to represent the location of the building which sits next to the street For example an offset of 50 feet means that the geocode will represent a point 50 feet back from the center of the street The distance is calculated perpendicular to the portion of the street segment for the address Offset is also used to prevent addresses across the street from each other from being given the same point The following diagram shows an offset point in relation to the original point Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 10 GeocodeAddressGlobal Parameter Description Offset Rie _Original Point Street coordinates are accurate to 1 10 000 of a degree and interpolated points are accurate to the millionths of a degree OffsetFromCorner Specifies the distance to offset the street end points in street level matching The distance is specified in the units you specify in the OffsetUnits option This value is used to prevent addresses at street corners from being given the same geocode as the intersection Note Offset is not
44. to the address The information contained in AdditionalFields varies by country HouseNumberHigh The highest address number for the range Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 22 GeocodeAddressGlobal Response Element Description HouseNumberLow The lowest address number for the range SegmentParity Indicates the side of the street where the range is located One of the following 0 It is not known which side of the street the range is located on 1 The range is on the left side of the street 2 The range is on the right side of the street HouseNumberParity Indicates whether the range contains odd or even address numbers One of the following 0 The range contains both odd and even address numbers 1 The range contains odd address numbers 2 The range contains even address numbers 1 Itis not Known whether the range contains odd or even house numbers TotalRangeUnitsReturned The number of unit ranges returned for the address A unit is an address within a building such as an apartment or suite RangeUnits A list of the ranges of units within the building An example of units are apartments or suites Address This is a list filed that contains sub fields for any address elements AddressLine1 City and so on that are different from the candidate s address UnitNumberHigh The highest unit number UnitNumberLow The lowest unit number Spectrum Technolog
45. to the portion of the street segment for the address Offset is also used to prevent addresses across the street from each other from being given the same point The following diagram shows an offset point in relation to the original point Offset Rie _Original Point Street coordinates are accurate to 1 10 000 of a degree and interpolated points are accurate to the millionths of a degree OffsetFromCorner Specifies the distance to offset the street end points in street level matching The distance is specified in the units you specify in the OffsetUnits option This value is used to prevent addresses at street corners from being given the same geocode as the intersection Note Offset is not supported for the United Kingdom GBR or Japan JPN Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 31 Parameter OffsetUnits CoordinateSystem ReverseGeocodeAddressGlobal Description The default value varies by country 12 meters Australia AUS Austria AUT Germany DEU 7 meters For other supported countries the default offset is 7 meters The following diagram compares the end points of a street to offset end points amp Q Street Segment End With Corner Offset Street Segment End Specifies the unit of measurement for the street offset and corner offset options One of the following Feet e Miles e Meters Kilometers The de
46. tters Remove spaces between house number and apartment letter 123 A Main Street does not geocode correctly because the geocoder assumes that the name of the street is A Two workaround options are available Do not include the apartment letter Delete the space between house number and apartment letter 123A Main Street geocodes because the geocoder ignores the A House numbers and unit information The house number pinpoints the location of the address Unit input can be in one of two formats as shown in the following examples 99 123 Main St where 99 is the unit number In this format do not specify the unit type The number 99 could be a suite apartment unit floor or any valid unit type 123 Main St Apt 99 where Apt is the unit type and 99 is the unit number In this format you must specify a valid unit type such as Apt or Suite otherwise the address will not be geocoded correctly Directional suffixes Use directional suffixes wherever possible This is especially true in towns and cities such as Calgary which consist mainly of numbered streets These streets can only be distinguished by their directional suffixes and street types They also distinguish addresses on streets that change direction For example 123 Main St W and 123 Main St E have very different coordinates Street types These distinguish different streets of the same name For example Main Avenue and Main Street are two entirely different entities
47. y Platform 10 0 Geocoding Guide for Canada SOAP 23 Response Element SegmentCode SegmentParity StateProvince StreetDataType StreetName StreetPrefix StreetSuffix TrailingDirectional UnitNumberHigh UnitNumberLow Return Parsed Address Spectrum Technology Platform 10 0 GeocodeAddressGlobal Description A unique ID that identifies a street segment Indicates which side of the street has odd numbers L Left side of the street R Right side of the street B Both sides of the street U Undetermined The meaning of State Province varies by country CAN Canada Province The default search order rank of the database used to geocode the address A value of 1 indicates that the database is first in the default search order 2 indicates that the database is second in the default search order and so on The default database search order is specified in the Management Console with the Database Resources tool For most countries this contains the street name The type of street when the street type appears before the base street name The type of street when the street type appears after the base street name Street directional that follows the street name For example the N in 456 3rd St N The highest unit number of the range in which the unit resides The lowest unit number of the range in which the unit resides The formatted input address can be returned along with a separate retur
48. y indicate that the record was matched by reverse geocoding The second two characters of the R result code indicate the type of match found R geocode results include an additional letter to indicate the dictionary from which the match was made Example reverse geocoding codes Table 18 Reverse Geocoding R Result Codes Reverse Geocoding Code Description Point parcel level precision for reverse geocoding Candidate returned from address dictionary Interpolated street candidate for reverse geocoding Candidate returned from address dictionary Street centroid candidate for reverse geocoding Candidate returned from address dictionary Non match Codes The following result codes indicate no match was made e N No close match e NX No close match for street intersections Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 41 Result Codes for International Geocoding e ND Spectrum Technology Platform could not find the geocoding database for the given postal code or municipality state province Spectrum Technology Platform 10 0 Geocoding Guide for Canada SOAP 42 Notices Copyright 2015 Pitney Bowes Software Inc All rights reserved MapInfo and Group 1 Software are trademarks of Pitney Bowes Software Inc All other marks and trademarks are property of their respective holders USPS Notices Pitney Bowes Inc holds a non exclusive license to publish and sell ZIP 4 database
Download Pdf Manuals
Related Search