the PDF - Support
Contents
1. gt lt geoc GeoCompleteRequest gt Jece Conte lt L lt geoc account id gt admin lt geoc account id gt lt ll OjoiesLiomeul gt lt geoc account password gt admin lt geoc account password gt lt geoc context gt zl Optional gt lt geoc options gt lt a Or lt geoc lt l Oje lt geoc cional 3 gt Database gt AUT lt geoc Database gt cional gt DatabaseSearchOrder gt lt geoc DatabaseSearchOrder gt lt l Optionals gt lt geoc Path gt lt geoc Path gt lt l Optionals gt lt geoc SearchDistance gt lt geoc SearchDistance gt Se epstonale gt lt geoc BBoxWest gt lt geoc BBoxWest gt a Oj OMA Ly gt lt geoc BBoxSouth gt lt geoc BBoxSouth gt Se operonelk gt lt geoc BBoxNorth gt lt geoc BBoxNorth gt lt l Opt ional g gt lt geoc BBoxEast gt lt geoc BBoxEast gt lt Optiionalki lt geoc GeoCompleteLevel gt lt geoc GeoCompleteLevel gt ST operomalen gt lt geoc GeoCompleteDictionaryPreference gt lt geoc GeoCompleteDictionaryPreference gt GeoComplete Guide 19 Sample SOAP Request and Response ISSO pito nai gt lt geoc SearchRadiusUnit gt lt geoc SearchRadiusUnit gt lt U SAM ao MEL gt lt geoc CoordinateSystem gt lt geoc CoordinateSystem gt C Opeon y gt lt geoc MaxCandidates gt lt geoc MaxCandidates gt lt geoc options gt lt geoc rows gt lt 1 or more rep2. Address Parameter AddressLine1 City County Country FirmName HouseNumber LastLine Latitude Longitude Locality PostalCode StateProvince CoordinateSystem Table 7 Outputs POI Parameter Description The first address line containing building number and street name The city name The local administrative unit for the address town city county etc The meaning of county varies by country The 3 character ISO country code Name of the firm or company House or street number The last line for the address Coordinates are returned For POI candidates these are exact coordinates For street candidates these coordinates are approximate The meaning of locality varies by country The postal code in the appropriate format for the country The meaning of State Province varies by country Coordinate System currently EPSG 4326 Description Name BrandName Category SubCategory miCode GeoComplete Guide Name of the POI Brand or business name associated with POI Major category of the POI Minor category of the POI 8 digit numeric codes for POI candidates that provide feature identification by general category subcategory and subfeature See miCodes on page 26 17 Sample REST Request and Response Parameter Description Response protocol Telephone number Email address Fax number Table 8 Outputs Common to Address and POI Parameter featurelD isUser
3. Longitude gt talCode gt StateProvince gt Wien lt StateProvince gt Distance gt 0 0 lt Distance gt lt DistanceUnit gt KILOMETERS lt DistanceUnit gt lt FormattedString gt Abbegasse 1140 Wien lt FormattedString gt lt IsUserDictionary gt false lt IsUserDictionary gt lt featureID gt 10400000701258 lt featurelD gt lt user fields gt lt user field gt lt name gt lt value gt lt user field gt lt user fields gt lt row gt lt row gt lt AddressLinel gt Am Abbrand lt AddressLinel gt 20 Spectrum Technology Platform 9 0 SP2 Chapter 2 GeoComplete API lt City gt Gaweinstal lt C lt County gt Mistelbach lt lt Country gt AUT lt Count LastLine gt 2191 Gawe Latitude gt 48 47551 lt Locality gt Gaweinsta Longitude gt 16 58547 PostalCode gt 2191 lt P ity gt County gt ey instal lt LastLine gt Latitude gt 1 lt Locality gt lt Longitude gt ostalCode gt StateProvince gt Nieder sterreich lt StateProvince gt gt Type gt 2 lt Type gt Distance gt 0 0 lt Dis IN UN VAN TAN ZA A A aneen lt DistanceUnit gt KILOMETERS lt DistanceUnit gt lt FormattedString gt Am Abbrand 2191 Gaweinstal lt FormattedString gt lt IsUserDictionary gt f lt featureID gt 10400002 lt user fields gt lt user field gt lt name gt lt value gt lt user_field gt lt user fields gt lt row gt lt row gt lt AddressLinel gt Abbe a
4. The GeoComplete Module databases are installed on the Spectrum Technology Platform server The databases are available by subscription from Pitney Bowes Software and are updated regularly The GeoComplete databases are delivered in several zip files according to region Installing one zip file installs all the included country databases However each country is separately licensed See the Installing GeoComplete Module Databases topic in the Installation Guide for a description of the provided database zip files and included counties See updated Release Notes for changes and information on newly supported countries GeoComplete Coverage The GeoComplete Module covers addresses and points of interest for the following countries Andorra AND Austria AUT Brazil BRA Belgium BEL Canada CAN Czech Republic CZE Denmark DNK Finland FIN France FRA Germany DEU Great Britain GBR 6 Spectrum Technology Platform 9 0 SP2 Chapter 1 Enterprise GeoComplete Hungary HUN Ireland IRL Italy ITA Japan JPN Kuwait KWT Liechtenstein LIE Luxembourg LUX Mexico MEX Netherlands NLD Norway NOR Poland POL Portugal PRT Russia RUS Singapore SGP Slovakia SVK Slovenia SVN South Africa ZAF Spain ESP Sweden SWE Switzerland CHE Turkey TUR United Arab Emirates ARE United States USA Note See the Spectrum Technology Platform version 9 0 SP2 Release Notes for more details of
5. Based On Input and GeoComplete Settings Input and GeoComplete Searchable Countries Search Behavior If input specifies a country Search only specified country if loaded If input specifies a bounding box Search only loaded countries intersecting point or box sort final list If GeoComplete specifies default countries such Only default countries are searched for example as USA CAN USA CAN If GeoComplete does not specify default country All loaded countries are searched or countries When GeoComplete searches all loaded countries significant performance issues may be encountered If your application calls for searching all loaded GeoComplete countries it is advisable to constrain the results using Management Console Language Support Some countries can include multiple dictionaries to support more than one language When you install databases for the following countries you can select more than one language dictionary Table 3 Countries with Multiple Language Support Language Databases Kuwait KWT English and Arabic Russia RUS English and Russian United Arab Emirates ARE English and Arabic Candidates are ordered by how close they are to the origin regardless of language However if candidates are equidistant from the origin then candidates matching the input language are listed first Spectrum Technology Platform 9 0 SP2 Chapter 1 Enterprise GeoComplete Standard and User Dictionary Suppor
6. CAN Type 990 north ma This returns 990 N Mary Lake Rd Huntsville ON P1H Notice that you entered North but the address is returned correctly as 990 N Mary Lake Rd as the address appears in the data source Start with focus in USA in Nashua NH Type 923 St This returns 923 Saint James Pl Nashua NH 03062 In this example St is recognized as street abbreviation for Saint POI Examples POI candidates include the full address POI category and subcategory and indicate the distance from the origin e You can simply allow your browser to automatically detect X Y coordinates as you would in a typical mobile application In this example starting from Troy NY search for a veterinarian As you type veteri As you type this you will see a list of nearby veterinary clinics e Start with a origin in Piccadilly Circus London Great Britain Type Restaurant Thai Or alternatively type Thai Either POI search returns Thai Restaurants near Piccadilly Circus Candidates include the full address POI category and indicate the distance from the origin Planning a trip to Cajun Country in Lafayette Louisiana type Lafayette la cash You will see a list of ATMs category of Cash Dispenser in Lafayette Louisiana e If you re looking for a hotel in the 92154 Zip Code area type hotel 92154 You will see a list of hotels in the 92154 ZIP Code area of San Diego California You can combine a POI brand name with the
7. Interest Codes micodes A Point of Interest Codes micodes In this section MICOdOS a are 26 miCodes Point of Interest candidates return the miCode These miCodes are eight digit numeric codes that provide feature identification by general category subcategory and subfeature Point of Interest miCodes are organized with the following numeric pattern POI miCode Numeric 10 all Point of Interest miCodes begin with the digits 10 Patterns Digits 3 and 4 identify the POI subcategory such as Shopping Retail and Wholesale Health Digits 5 through 8 identify the subfeature codes such as Food Stores Hospital Polyclinic Point of Interest miCodes are assigned universally across all countries Table 9 POI miCodes 10 Points Of Interest Subfeature Codes miCodes Subcategories 00 Unclassified 00 Unclassified 10000000 01 Shopping Retail and 0000 Unclassified 10010000 Wholesale 0000 Unclassified 10010000 0100 General Merchandise 10010100 Stores Shops 0101 Department Stores 10010101 0102 Variety Stores 10010102 0103 Warehouse Club Stores 10010103 0200 Food Stores 10010200 0201 Food Stores Supermarket 10010201 0203 Food Stores Fish Seafood 10010203 Market 0204 Food Stores 10010204 Fruits Vegetable Market 0205 Beverage Bottle Store 10010205 0300 Apparel and Accessory 10010300 0400 Auto Sales and Service 10010400 Stations 0401 Car Dealership Sales 10010401 0402 Car Dealership Service 1
8. NAVTEQ All rights reserved Data 2014 NAVTEQ North America LLC Fuente INEGI Instituto Nacional de Estadistica y Geografia Based upon electronic data National Land Survey Sweden Copyright United States Census Bureau Copyright Nova 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 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 rest
9. coordinate defining the western boundary of the bounding box For example 97 615642 BBoxNorth The coordinate defining the northern boundary of the bounding box For example 30 351415 BBoxSouth The coordinate defining the southern boundary of the bounding box For example 30 115302 From these coordinates GeoComplete constructs a rectangle that defines the boundaries that will be searched This example constructs a bounded area centered around Elgin Texas This extent of the search polygon can also be controlled through the API See Options on page 16 Search Distance Units Search distance units can be miles or kilometers The default is kilometers Data Preferences From Management Console Modules Services In the Options tab select Data and choose from the following options Database Select the country from the drop down Database Preference Select a single dictionary to use or a preferred dictionary The default is Use Both Dictionaries which means that both standard and user dictionaries are used with the best close match returned from either a standard or user dictionary The choices are e Use Standard Dictionary Only e Use User Dictionary Only Use Both Dictionaries Default e Prefer User Dictionary e Prefer Standard Dictionary Order Installed Data Resources If you have multiple database resources installed you can select the order in which they are searched For example if you had bo
10. country coverage and data vintages Newly supported countries and updated data vintages will be covered in regularly updated release notes GeoComplete Module Features The GeoComplete Module provides the following capabilities when built into your Spectrum Technology Platform application The following capabilities are supported Select country optional See GeoComplete Coverage on page 6 for a list of available countries Single line input search for street addresses e Candidates returned in order based on distance from X Y origin e Search Points of Interest POI Search All to include both street addresses and POI Search POI categories and subcategories Search for brand such as a specific hotel chain in categories and subcategories e Search multiple countries at once English language for all countries plus national language for select countries For both address searches and POI searches candidates are displayed as you type As you type more specific information the results are refined to display more relevant candidates Candidates include the GeoComplete Guide 7 GeoComplete Module Features full address POI category and subcategory ifthe candidate is a Point of Interest and indicate the distance from the origin The GeoComplete Module is packaged with a sample application that demonstrates many capabilities This sample application includes a mapping feature but it does not represent all the capabiliti
11. 0010402 0403 Car Dealership Sales and 10010403 Service 0404 Car Repair Facilities 10010404 0405 Car Rental Office 10010405 0410 Motorcycle Sales and 10010410 Service 0500 Gas Petrol Stations 10010500 26 Spectrum Technology Platform 9 0 SP2 Appendix A Point of Interest Codes micodes 10 Points Of Interest Subfeature Codes miCodes Subcategories 0600 Furniture and Home 10010600 Furnishings 0700 Building Materials AND 10010700 Garden Supplies 0800 Wholesale Trade Durable 10010800 AND Non durables 0900 Shopping Malls Shopping 10010900 Centers 02 Eating and Drinking Places 0000 Unclassified 10020000 0101 Restaurants Ethnic 10020101 American 0102 Restaurants Ethnic 10020102 Chinese 0103 Restaurants Ethnic Italian 10020103 0104 Restaurants Ethnic 10020104 German 1050 Restaurants Ethnic 10020105 French 0106 Restaurants Ethnic 10020106 Japanese 0107 Restaurants Ethnic 10020107 Indian 0108 Restaurants Ethnic Thai 10020108 0109 Restaurants Ethnic 10020109 Vietnamese 0110 Restaurants Ethnic 10020110 Middle East 0111 Restaurants Ethnic 10020111 Greek 0112 Restaurants Ethnic 10020112 Mexican 0200 Restaurants Ice 10020200 Cream Soda 0300 Restaurants Fast Food 10020300 0400 Restaurants Family 10020400 0500 Restaurants Pizza 10020500 0600 Restaurants Seafood 10020600 0700 Restaurants 10020700 Drinking Alcoholic 0800 High Concentra
12. 300 Colleges Universities 10210300 0400 Vocational Trade 10210400 0500 Special Schools 10210500 0600 Library 10210600 0700 Child Care Center 10210700 22 Places of Worship 0100 Church 10220100 0101 Baptist Church 10220101 0102 Catholic Church 10220102 0103 Methodist Church 10220103 0200 Mosque 10220200 0300 Synagogue 10220300 0400 Buddhist Temple 10220400 0500 Hindu Temple 10220500 0600 Other 10220600 23 Health 0000 Health Facilities Undefined 10230000 0010 Pharmacy 10230010 0100 Hospital Polyclinic 10230100 0200 Nursing and Personal Care 10230200 0300 Office Clinic of Medical 10230300 Doctors 0400 Office Clinic of Dentist 10230400 0500 Medical Dental 10230500 Laboratories Services 0600 Ambulance Station 10230600 0700 Veterinarian Clinic Hospital 10230700 24 Public 0000 All 10240000 Spectrum Technology Platform 9 0 SP2 Appendix A Point of Interest Codes micodes 10 Points Of Interest Subfeature Codes miCodes Subcategories 0100 Government Facilities 10240100 0101 City Municipal Local Facility 10240101 0102 Courts 10240102 0103 Embassy Foreign 10240103 Government Representation 0104 Frontier Crossing 10240104 0300 Police Station Facility 10240300 0400 Fire Stations 10240400 0500 Post Office 10240500 0501 Post Office Main 10240501 0502 Post Office Minor 10240502 0600 Prisons 10240600 0700 Military base Defense 10240700 0800 Cemetery Crematorium 10240800 0900 Waste Disposal Sewerage 10240900 31 A
13. Dictionary FormattedString Type Status Status Code Status Description Description unique ID for the address or POI True or False whether returned candidate came User Dictionary Single line representation of an address or POI Whether the response contains a POI Type 1 or address Type 2 Information returned about the status of the request Status code related to the request Status description related to the request Sample REST Request and Response 18 Following is a sample REST request and response used to call GeoComplete Sample REST Request Below is a sample REST request http localhost 8080 rest GeoComplete results xml Data AddressLinel absamp Option Database AUT Sample REST Response Below is a sample REST response lt xml GeoCompleteRespons lt output_port gt lt Address gt lt AddressLinel gt Abbegas lt City gt Wien lt City gt lt County gt Wien lt County gt gt se lt AddressLinel gt lt Country gt AUT lt Country gt lt LastLine gt 1140 Wien lt Latitude gt 48 2051 lt La Locality gt Wien lt Local Longitude gt 16 29514 lt PostalCode gt 1140 lt Pos StateProvince gt Wien lt Type gt 2 lt Type gt Distance gt 0 0 lt Dista lt DistanceUnit gt KILOMET lt FormattedString gt Abbe lt IsUserDictionary gt fal lt featureID gt 1040000070 lt user fields gt IN IN IS IN IS T amp S LastLine gt titude gt ity gt Longitude gt talC
14. Spectrum Technology Platform Version 9 0 SP2 GeoComplete Guide Contents Chapter 1 Enterprise GeoComplete cccccccccccccccccncccnncnnnennnennnennnnnnnnnnnanannns 5 GeoGomplete Module Renner each 6 GeoComplete Stage ocaso meant dt ecetes ceed 6 GeoComplete Database Resources uunsuununnnnnnnnnannannnnnnnnnnnnnnnnnnnnannnnnnnnnnnnn 6 GeoComplete Coverage uesssuu0 004srnananeennn crac ic ann nennen na 6 GeoComplete Module Features unssusnunnnnnnannanannnnnnnnnnnnnnnnnnanannnnnnnnnnnnn 7 Street Searching Features nu ae 8 Point of InterestFealures nn ana a 8 Point of Interest Categories and Subcategories uunessnnsennsssnnnnnnnennnnnn 9 PO Name S Gann ssc css sewnns tas anna 9 Retumed Candidate Fields ideas 9 Typical Applicaton Example Sinorino anorni erotutsananiede 10 Multiple Country Language and User Dictionaries uuruuennennennn 12 GeoComplete Preferences in Management Console nensnsennnennnennnnnennnnnnn 13 Chapter 2 GeoComplete APl usa 15 Using the PRP aia iets ili ese eine ste hd eee a 16 INP island 16 OPUONS uan dira doses latidos ads 16 OUIPUIS aia 17 Sample REST Request and Response nuusssssssnannnnnnnnnnnnnnnnnnnnnanmnnnnnnnnnnnnnn 18 Sample SOAP Request and Response nuussssnssnannnnnnnnnnnnnnnnnnnnnannnnannnnnnnnnnn 19 APPENA Cee re Pee IE SUR cet rereere rer tre a aa a rer tert tere cer eer t
15. ation to identify your geographic location Your location will also determine the default country For the purposes of these examples we will assume that the default is USA but you can change this to any supported country See GeoComplete Coverage on page 6for a list of available countries See Using the API on page 16 for a description of all the options than can be controlled through the API Numbered Street Examples The following example describes a GeoComplete example with a New York City numbered street Start with focus in USA New York City midtown Manhattan Type 60 east 4 s This returns 60 E 4th St New York NY 10003 60 E 4th St Brooklyn NY 11218 The New York Manhattan address is returned first because this is closest to the origin An identical address exists in Brooklyn NY several miles further from the origin Others addresses are returned in increasingly further distance from the X Y origin Spectrum Technology Platform 9 0 SP2 Chapter 1 Enterprise GeoComplete The following example describes a GeoComplete example with a numbered street in Italy e Start with focus in Italy ITA in the city of Palermo Type via 4 This returns Via 4 Aprile 90133 Palermo A total of ten via 4 and via Quarto street addresses are returned in increasing distance from origin The word Quarto is recognized as the number 4 in street name Street and Directional Abbreviation Examples e Start with focus in Canada
16. city name For example if you re looking a favorite seafood restaurant in Scarborough Maine you could type clambake scar As you type this you will see the listing for the Clambake Restaurant in Scarborough Maine You can combine POls with GeoComplete Guide 11 Multiple Country Language and User Dictionaries Multiple Country Language and User Dictionaries 12 If you use GeoComplete with more than one country selected rules are used to determine which country has search priority You can also have more than one dictionary per country to support standard and custom user dictionaries For some countries multiple dictionaries can support more than one language Multiple Country Support and Search Priority If multiple countries are available to GeoComplete countries are searched based on default rules and user input The default country or countries can be set in the GeoComplete component during installation In most applications you would select only one country or perhaps two neighboring countries such as USA CAN You can select All to add the database resources for all the available GeoComplete databases You can also define a default country or countries at the Spectrum Management Console level You can use this to control the number of countries searched even ifthe GeoComplete module allows all loaded countries to be searched Multiple country searching behavior can be summarized as follows Table 2 Countries Searched
17. error rere rece percrer cere eer eee 23 Appendix A Point of Interest Codes micodes ccsseecceeseeeeees 25 MIOS Snes 26 Enterprise GeoComplete In this section e GeoComplete Module 00 20e cece eee 6 e GeoComplete Stage cece eee eee eee 6 e GeoComplete Database Resources 6 e GeoComplete Coverage 00 cence eee eee eee 6 GeoComplete Module FeatureS 0oooooo 7 e Multiple Country Language and User Dictionaries 12 e GeoComplete Preferences in Management Console 13 GeoComplete Module GeoComplete Module The module for Spectrum Technology Platform automatically suggests addresses and points of interest as you type and immediately returns candidates based on your input You can then select your candidate to see the pinpoint location on a map This as you type recognition of addresses and points of interest is particularly valuable for mobile applications and can be incorporated into many business applications The component is delivered as a Spectrum module and can be built into Spectrum stages just like any other component Spectrum Technology Platform 9 0 must already be installed GeoComplete Stage The Enterprise GeoComplete Module consists of the following stage GeoComplete Automatically suggests addresses and points of interest as you type and immediately returns candidates based on your input GeoComplete Database Resources
18. es of GeoComplete This is for sample and demonstration purposes only and is not a supported application After installing and deploying the GeoComplete Module you can use the Management Console to explore all the capabilities and see candidate results You can expose additional features and preferences through the REST and SOAP API See Using the API on page 16 Street Searching Features With Street searching you can search on all address elements including street name city locality state province postcode You can also include POI categories subcategories place names and brand names as part of a street address search The entry format can include any combination of the following address elements Consider listing the street name before the area names for more efficient searching street name area name 4 area name 3 area name 2 area name 1 post _code lt POI fields gt where street name area name 4 area name 3 area name 2 area name 1 post code street_name are street name locality city town county region state province and postal code or equivalent address elements lt POI fields gt are equivalent to generic_field_4 subcategory generic_field_3 category place_name brand_name As you type more specific information the results are refined to display more relevant candidates Candidates include the full address POI category and subcategory and indicate the distance from the origin Candidates ma
19. etitions gt lt geoc row gt lt You may enter the following 5 items in any order gt lt geoc AddressLinel gt a lt geoc AddressLinel gt ST opEronale gt lt l Optional gt lt geoc Country gt lt geoc S Optional gt Country gt lt geoc OriginLatitude gt lt geoc OriginLatitude gt lt Opri onal gt lt geoc OriginLongitude gt lt geoc OriginLongitude gt SI opEXenale gt lt Jeoe users Tieles lt Zero or more repetitions gt lt geochusersr reild gt lt geoc name gt lt g oc name gt lt geoc value gt lt geoc value gt lt geoc user field gt lt geoc user fields gt lt geoc row gt lt geoc rows gt lt geoc GeoCompleteRequest gt lt soapenv Body gt lt soapenv Envelope gt Sample SOAP Response Below is a sample SOAP response lt soap Envelope xmlns soap http schemas xmlsoap org soap envelope gt lt soap Body gt lt GeoCompleteResponse xmlns http www gl com services GeoComplete gt lt rows gt lt row gt lt AddressLinel gt Abbegas se lt AddressLinel gt lt City gt Wien lt City gt lt County gt Wien lt County gt lt Country gt AUT lt Country gt LastLine gt 1140 Wien lt Latitude gt 48 2051 lt La Longitude gt 16 29514 lt PostalCode gt 1140 lt Pos S Type gt 2 lt Type gt KIND KAN ANA LastLine gt titude gt Locality gt Wien lt Locality gt
20. h to database The distance radius to search for candidates from the given origin Distance units miles or kilometers are defined by the SearchRadiusUnits method This distance is also used as a search distance restriction The coordinate defining the western boundary of the bounding box The coordinate defining the southern boundary of the bounding box The coordinate defining the northern boundary of the bounding box The coordinate defining the eastern boundary of the bounding box The level to be searched This can be Address POI Category or ALL to search both street addresses and points of interest The dictionary preference whether to use a user dictionary standard dictionary or both and whether to prefer one over the other Spectrum Technology Platform 9 0 SP2 Parameter Option SearchRadiusUnit Option CoordinateSystem Option MaxCandidates Outputs Chapter 2 GeoComplete API Description Units feet miles meters kilometers used for Option SearchDistance If not specified kilometers km is used unless you changed that preference in Management Console These units are also used as a search distance restriction Coordinate system to use Currently only EPSG 4326 is supported Maximum number of candidates to return 1 100 Or specify 1 to return the maximum allowable number of candidates 100 The GeoComplete API supports the following output parameters Table 6 Outputs
21. igin was not used DistanceUnit Distance unit kilometers or miles GeoComplete Guide 9 GeoComplete Module Features Field Name Description Category For POI candidates this is the Category Subcategory For POI candidates this is the Subcategory brand_name For POI candidates this is a Brand or business name For example this can be the name of a specific hotel motel chain or email For POI candidates this is the email address faxnum For POI candidates this is the fax number featurelD unique FeaturelD http For POI candidates this is the web site if available isUserDictionary True if candidate comes from a user dictionary false if not from user dictionary micode For POI candidates this is miCode is an eight digit numeric code that identifies POI features by category subcategory and subfeature This is not the same as the featurelD and is not related to the Category and Subcategory fields described above See miCodes on page 26 for a comprehensive listing of miCodes that are used for all countries telnum For POI candidates this is the telephone number latitude longitude Latitude Longitude coordinates are returned For POI candidates these are exact coordinates For street candidates these coordinates are approximate To get a more exact coordinates you must perform a geocode operation on the street candidate Typical Application Examples 10 In a typical mobile application you would allow the applic
22. irports 0000 Unclassified 10310000 0010 Check in Facility at Airport 10310010 0011 Check in Facility at Airport 10310011 Departures 0012 Check in Facility at Airport 10310012 Arrivals 0010 Check in Facility at Airport 10310013 Departure Arrivals 0100 Airport Civil 10310100 0101 Airport Public 10310101 0102 Airport Private 10310102 0200 Airport Military 10310200 0300 Helipad 10310300 32 Stations 0000 Unclassified 10320000 0100 Ferry terminal 10320100 Wharf Jetty Pontoon 0101 Ferry Terminal 10320101 Ship Hovercraft 0102 Ferry Terminal Train 10320102 0200 Railway Station Undefined 10320200 0201 Railway Station 10320201 Underground Metro 0202 Railway Station 10320202 International GeoComplete Guide 31 32 10 Points Of Interest Subcategories 33 Parking 34 Interchanges Subfeature Codes 0203 Railway Station National 0204 Railway Station Sub Urban 0300 Bus Terminal Depot 0000 Parking Unclassified 0100 Parking Garage 0200 Open Parking Area 0300 Rent a Car Parking 0210 Park and Ride Lot 0000 Intersection 0100 Freeway Exit Entrance 0200 Freeway to Freeway Interchange 0300 Non Freeway Intersection Spectrum Technology Platform 9 0 SP2 miCodes 10320203 10320204 10320300 10330000 10330100 10330200 10330300 10330210 10340000 10340100 10340200 10340300 Notices 34 2014 Pitney Bowes Software Inc All rights reserved MapInfo and Group 1 Software are t
23. logy Platform 9 0 SP2 Chapter 1 Enterprise GeoComplete Instead of providing an area for POI search you can constrain results by the search extent from the origin or by a bounding box See GeoComplete Preferences in Management Console on page 13 for information on these preferences Note POls can only be searched in one country at a time If a country code is not provided then the current location can be used to set the country If no country or location is provided then a default country will be used For examples that illustrate POI see Typical Application Examples on page 10 Point of Interest Categories and Subcategories Category and Subcategory Classification Points of Interest POI are classified into categories and subcategories These categories subcategories are returned with POI candidates and you can also use these categories subcategories for searching This two level classification is simple and allows you to search and identify POls including but not limited to restaurants hotels entertainment sites hospital medical facilities shopping and retail establishments and other businesses The category and subcategory names are appropriate for terminology variations For example Cash Point Cash Dispenser Cash and ATM are all terms that identify cash dispensing devices You can search any of these terms with the GeoComplete Module to identify cash dispensing devices Categories are broad in nature such as Restauran
24. lse lt IsUserDictionary gt 963709 lt featurelD gt Stadler Gasse lt AddressLinel gt lt City gt Melk lt City gt lt County gt Melk lt Count lt Country gt AUT lt Count LastLine gt 3390 Melk Latitude gt 48 226780 Locality gt Melk lt Loc Longitude gt 15 33421 PostalCode gt 3390 lt P StateProvince gt Nied IX IN AK IK IN IN y gt Ey lt LastLine gt 000000005 lt Latitude gt city 5 lt Longitude gt ostalCode gt r sterreich lt StateProvince gt lt Type gt 2 lt Type gt lt Distance gt 0 0 lt Dis lt DistanceUnit gt KILOM lt FormattedString gt Ab Melk lt FormattedString gt lt IsUserDictionary gt f lt featureID gt 10400001 lt user fields gt lt user field gt lt name gt lt value gt lt user field gt lt user fields gt lt row gt 7 lt row gt tance gt ETERS lt DistanceUnit gt b Stadler Gasse 3390 alse lt IsUserDictionary gt 649751 lt featurelD gt lt AddressLinel gt A 23 Verteilerkreis Kaiserm hlendamm lt AddressLinel gt lt City gt Wien lt City gt lt County gt Wien lt Count lt Country gt AUT lt Count PostalCode gt 1220 lt P Type gt 2 lt Type gt Distance gt 0 0 lt Dis UNE NEE NO NN SEN y gt yo LastLine gt 1220 Wien lt LastLine gt Latitude gt 48 2113 lt Latitude gt Longitude gt 16 44237 lt Longitude gt ostalCode gt StateProvince gt Wien lt StateProvince gt tance gt lt Di
25. miCodes Subcategories 0100 Sport Center Stadium 10120100 0101 Tennis Court 10120101 0102 Cricket 10120102 0103 Football Soccer 10120103 0104 Baseball 10120104 0105 Ice Skating Rink 10120105 0106 Hockey 10120106 0107 Basketball Netball 10120107 0108 Golf Course 10120108 0109 Race Course 10120109 0110 Rifle Range 10120110 0111 Bowling Center 10120111 0300 Water Sport 10120300 0301 Swimming Pool 10120301 0302 Yacht Basin 10120302 0400 Sports Club 10120400 0500 Health Club 10120500 0600 Ski Resort 10120600 13 Recreation Entertainment 0000 Unclassified 10130000 0100 Cultural Civic Community 10130100 Center 0101 Theater 10130101 0102 Opera 10130102 0103 Concert Hall 10130103 0104 Music Center 10130104 0105 Cinema 10130105 0200 Leisure Center 10130200 0201 Park 10130201 0202 Zoo 10130202 0203 Amusement Park 10130203 0204 Camping Ground Caravan 10130204 park 0205 Fairgrounds 10130205 0206 Night Life Clubs 10130206 0207 Casino 10130207 0208 Recreational Clubs 10130208 0300 Convention Center 10130300 GeoComplete Guide 29 10 Points Of Interest Subfeature Codes miCodes Subcategories 0301 Exhibition Center 10130301 21 Educational 0000 Educational 10210000 0100 Kindergarten Nursery 10210100 School 0200 Elementary Middle High 10210200 School 0201 Elementary Middle High 10210201 School Catholic 0202 Elementary Middle High 10210202 School Private 0203 Elementary Middle High 10210203 School Public 0
26. ntries GeoComplete will consider candidates from each country sort them internally and then present the maximum number of candidates based on the combined countries So whether the default country is set to USA CAN or CAN USA GeoComplete returns the same list of candidates tied candidates would use country order as a tiebreaker Searching multiple countries using GeoComplete will impact performance Search Preferences From Management Console Modules Services select GeoComplete In the Options tab select Search Restrictions and choose from the following options Default Search Select Address POI or All Distance from Origin Select this to specify the search extent as the maximum distance from the X Y origin This search distance is unlimited by default Search Distance Units miles or kilometers can also be specified on the GeoComplete Options tab The distance from origin and the distance units kilometers or miles can also be controlled through the API See Options on page 16 GeoComplete Guide 13 GeoComplete Preferences in Management Console Within Bounding Box Select this to specify the X Y coordinates of a polygon that defines the area in which to search for candidates The polygon is delimited by four sets of X Y coordinates defining the corners of the polygon The corners are defined as BBoxEast The coordinate defining the eastern boundary of the bounding box For example 97 149410 BBoxWest The
27. ode gt StateProvince gt nce gt ERS lt DistanceUnit gt gasse 1140 Wien lt FormattedString gt se lt IsUserDictionary gt 1258 lt featureID gt Spectrum Technology Platform 9 0 SP2 lt Address gt lt Address gt Chapter 2 GeoComplete API lt AddressLinel gt Abbrenn lt AddressLinel gt lt City gt wildalpen lt City gt lt County gt Liezen lt lt Country gt AUT lt C Latitude gt 47 72 Longitude gt 15 0 PostalCode gt 892 StateProvince gt Type gt 2 lt Type gt Distance gt 0 0 lt ee NEE SE NNN NN County gt ountry gt LastLine gt 8924 Wildalpen lt LastLine gt 265 lt Latitude gt 22765 lt Longitude gt 4 lt PostalCode gt Steiermark lt StateProvince gt Distance gt DistanceUnit gt KILOMETERS lt DistanceUnit gt lt FormattedString gt Abbrenn 8924 Wildalpen lt FormattedString gt lt IsUserDictiona lt featureID gt 1040 lt user fields gt lt Address gt lt output_port gt ry gt false lt IsUserDictionary gt 0001526402 lt featureID gt lt xml GeoCompleteResponse gt Sample SOAP Request and Response Following is a sample SOAP request and response used to call GeoComplete Sample SOAP Request Below is a sample SOAP request lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope xmlns geoc http lt soapenv Header lt soapenv Body gt www gl com services GeoComplete gt
28. rademarks 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 databases 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 LACS NCOA 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 NCOAL 0 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 O Copyright United States Postal Service All rights reserved O 2014 TomTom All rights reserved TomTom and the TomTom logo are registered trademarks of TomTom N V O Copyright
29. riction including without limitation the rights to use copy modify merge publish distribute and or sell copies of the Spectrum Technology Platform 9 0 SP2 Copyright Software and to permit persons 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 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FORANY CLAIM ORANY 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 GeoComplete Guide 35
30. stanceUnit gt KILOMETERS lt DistanceUnit gt lt FormattedString gt A 2 Wien lt FormattedString gt 3 Verteilerkreis Kaiserm hlendamm 1220 lt IsUserDictionary gt false lt IsUserDictionary gt lt featureID gt 10400003 lt user fields gt lt user field gt lt name gt lt value gt lt user field gt GeoComplete Guide 407202 lt featurelD gt 21 Sample SOAP Request and Response 22 lt user fields gt lt row gt lt row gt lt AddressLinel gt lt City gt Amaliendorf Aalfang lt City gt lt County gt Gm nd lt County gt lt Country gt AUT lt Country gt LastLine gt 3872 Amaliendorf Aalfang Aalfang lt LastLine gt Latitude gt 48 838915 lt Latitude gt Locality gt Aalfang lt Locality gt Longitude gt 15 06984 lt Longitude gt PostalCode gt 3872 lt PostalCode gt StateProvince gt Nieder sterreich lt StateProvince gt Type gt 2 lt Type gt Distance gt 0 0 lt Distance gt lt DistanceUnit gt KILOMETERS lt DistanceUnit gt lt FormattedString gt 3872 Amaliendorf Aalfang Aalfang lt FormattedString gt lt IsUserDictionary gt false lt IsUserDictionary gt lt user fields gt lt user field gt lt name gt lt value gt lt user field gt lt user fields gt lt row gt lt rows gt lt GeoCompleteResponse gt lt soap Body gt lt soap Envelope gt KINA AANA AA Spectrum Technology Platform 9 0 SP2 Appendix In this section Point of
31. t The GeoComplete Module supports both standard dictionaries and custom user dictionaries The Management Console and API allow you to choose which dictionary if any has preference See GeoComplete Preferences in Management Console on page 13 By default both standard and user dictionaries if any are used and results from the standard dictionary are preferred Note If you have a user dictionary for a country it must be located in the same folder as the standard dictionary GeoComplete Preferences in Management Console You can use several GeoComplete preferences to more precisely control the number and distance of retrieved candidates These preferences can be controlled through the Spectrum Management Console or through equivalent API methods See Using the API on page 16 Note The GeoComplete component is delivered as an 9 2 9 0 SP2 module and can be built into Spectrum stages just like any other component Geocomplete Options From Management Console Modules Services select GeoComplete In the Options tab select GeoComplete and choose from the following options e Geocomplete Level Select Street POI or All e Coordinate System EPSG 4326 is currently the only supported coordinate system Max Candidates Select 1 100 to specify the maximum number of candidates returned A value of 1 specifies the maximum allowable number of candidates 100 If Max Candidates is not specified the default is 5 If you search multiple cou
32. th the USA and CAN databases installed you could order CAN first and USA second or vice versa Use the Move Up and Move Down buttons to change the order the database resources 14 Spectrum Technology Platform 9 0 SP2 GeoComplete API In this section Using the API 0 0022 an 16 Sample REST Request and Response 18 Sample SOAP Request and Response 19 Using the API Using the API This section describes the GeoComplete API Both SOAP and REST are supported Inputs The GeoComplete API supports the following input parameters Table 4 Inputs Parameter Description Data AddressLine1 Single line address Data Country The 3 character ISO country code Data OriginLatitude Y Coordinate of origin Data OriginLongitude X Coordinate of origin Options 16 The GeoComplete API supports the following optional parameters Table 5 Options Parameter Option Database Option DatabaseSearchOrder Option Path Option SearchDistance Option BBoxWest Option BBoxSouth Option BBoxNorth Option BBoxEast Option GeoCompleteLevel Option GeoCompleteDictionaryPreference Description The name of the database configured in Management Console In the case of multiple dictionaries in a database this allows you to set the dictionary preference This controls whether candidates from one dictionary are returned ahead of similar candidates from another dictionary Pat
33. tion of 10020800 Restaurants GeoComplete Guide 27 28 10 Points Of Interest Subcategories 03 Business and Personal Services 04 Other Business 11 Tourism 12 Sports Subfeature Codes miCodes 0000 Unclassified 10030000 0100 Hotels Motels 10030100 0200 Personal Service Business 10030200 0201 Laundromat 10030201 0202 Salons 10030202 0300 Financial Services 10030300 0301 Banks 10030301 0302 ATM Machine Cash 10030302 Dispenser 0400 Broadcasting Service 10030400 0500 Automobile Club 10030500 0000 Office Company Industry 10040000 0100 Agriculture and Mining 10040100 0101 Mine Quarry 10040101 0200 Manufacturing 10040200 0000 Unclassified 10110000 0100 Tourist Attraction 10110100 0200 Tourist Attraction Building 10110200 0201 Museum 10110201 0202 Art Gallery Art Center 10110202 0203 Aquarium 10110203 0300 Tourist Attraction 10110300 Monument 0301 Memorial 10110301 0400 Tourist Attraction Natural 10110400 0401 Scenic Panoramic View 10110401 0402 Beach Represented bya 10110402 Point 0403 Mountain peak 10110403 0405 Mountain pass 10110405 0500 Tourist Attraction Historic 10110500 Site 0600 Tourist Attraction Other 10110600 0601 Winery 10110601 0700 Tourist Information Center 10110700 0800 Rest Area Public 10110800 0000 Sports Unclassified 10120000 Spectrum Technology Platform 9 0 SP2 Appendix A Point of Interest Codes micodes 10 Points Of Interest Subfeature Codes
34. ts Subcategories are more specific such as Barbeque Restaurants Barbeque or BBQ Any other type of ethnic or specialty restaurant could also be a subcategory Similarly Automotive is a category with many subcategories including Car Service Car Repair Car Sales Tire Services Tyre Services American and British spelling variations of tire and tyre POI Name Searching Points of Interest can also be searched by using the name of a business brand institution or other specifically named site These names are also are returned with POI candidates if available For example you can search for a specific coffee shop sports stadium hospital hotel park shop restaurant tourist attraction or any other site This may be important if you are looking for a specific brand name hotel motel chain or cafe in your location See Typical Application Examples on page 10 for examples of POI searching with the GeoComplete Module Returned Candidate Fields Additional Returned Fields Returned candidates can be previewed in the Management Console Candidates include the complete address elements that you expect to see in Spectrum Technology Platform candidates such as AddressLine City County State and Country In addition GeoComplete candidates return the following fields Table 1 GeoComplete Additional Returned Fields Field Name Description Distance Distance from origin in kilometers or miles A distance of 0 0 means that an or
35. y also display other descriptive information such as a web page address Instead of providing an area for POI search you can constrain results by the search extent from the origin or by a bounding box See GeoComplete Preferences in Management Console on page 13 for information on these preferences Point of Interest Features With Point of Interest POI searching you can enter a specific name such as a hotel name a category such as Restaurant or subcategory such as Thai Restaurant The entry format is either of the following lt brand name category or subcategory gt lt optional area gt lt optional area gt gt lt brand name category or subcategory gt where lt brand name category or subcategory gt isa point of interest such as the name of a specific bank restaurant or hospital or a category such as parking lot or petrol station or subcategory such as Thai Restaurant lt optional area gt canbea street name city state province postcode or any combination of searchable address fields This area information is optional but if provided it will limit the candidates to the specified area As you type more specific information the results are refined to display more relevant candidates Candidates include the full address POI category and subcategory and indicate the distance from the origin See Returned Candidate Fields on page 9 for a list of additional fields returned with POls 8 Spectrum Techno
Download Pdf Manuals
Related Search