Page | 1 GeoPinpoint Suite – Application Program Interface User Manual v2010.3 Published Date: August 15, 2010 DMTI Spatial Inc. Email: [email protected] 15 Allstate parkway, Phone: (877) 477-3684 DMTI Spatial Inc. 625 Cochrane Dr., 3rd Floor, Markham, Ontario, Canada,Suite L3R 9R9400 Fax: (905) 948-9404 www.dmtispatial.com Markham, Ontario L3R 5B4 www.dmtispatial.com 2010 DMTI Spatial Inc. Page 2 Page 2 Table of Contents Really Smart Spatial Solutions™ ........................................................................................................................... 5 Technical Support, Error Reporting & Product Enhancement Services ................................................................. 6 Contact Information ................................................................................................................................................ 6 Trademarks and Notices ........................................................................................................................................ 6 ABOUT GEOPINPOINT™ SUITE ............................................................................................................................. 7 Overview ................................................................................................................................................................. 7 Features.................................................................................................................................................................. 7 WHAT’S NEW IN GEOPINPOINT™ SUITE .............................................................................................................. 9 Software Changes .................................................................................................................................................. 9 Documentation Changes ........................................................................................................................................ 9 CANADIAN GEOGRAPHY AND DATA - SUMMARY ............................................................................................ 10 Coordinate Systems ............................................................................................................................................. 10 Basic Canadian Geography.................................................................................................................................. 10 CanMap Street Files ............................................................................................................................................. 10 Census Subdivision (CSD) centroids ................................................................................................................... 11 Municipal Centroids .......................................................................................................................................................... 11 Municipal Aliases .............................................................................................................................................................. 11 Points of Interest (POI) ......................................................................................................................................... 12 Populated Place Names (PPN) ............................................................................................................................ 13 OM* Platinum Postal Code Suite - Forward Sortation Area (FSA) Boundaries ....................................................... 14 OM* Platinum Postal Code Suite - Local Delivery Unit (LDU) ................................................................................. 14 GEO-REFERENCE DATABASE ............................................................................................................................. 15 Source Data .......................................................................................................................................................... 15 Version Changes .................................................................................................................................................. 15 Location ................................................................................................................................................................ 15 Software Versions ................................................................................................................................................ 16 Version Text File ................................................................................................................................................... 16 DEFINING THE GEOCODING PATH ..................................................................................................................... 17 Geocoding By Municipality and FSA… ............................................................................................................................. 18 Municipality Aliasing ......................................................................................................................................................... 20 Geocoding By FSA… ....................................................................................................................................................... 22 Address Geocoder ............................................................................................................................................................ 24 Point Of Interest (POI) Geocoder ..................................................................................................................................... 27 Postal Code Geocoder ..................................................................................................................................................... 33 Segment Geocoder .......................................................................................................................................................... 34 SAMPLE APPLICATION PROGRAM INTERFACE ............................................................................................... 40 Programming Steps .......................................................................................................................................................... 40 Step 1: Declare a Geocoder Class Instance ..................................................................................................................... 40 Step 2: Initialize the Geocoder .......................................................................................................................................... 40 Step 3: Set Input Street Information ................................................................................................................................. 40 Step 4: Set Processing Options ........................................................................................................................................ 41 Step 5: Define Geocoding Path ........................................................................................................................................ 41 Step 6: Perform Geocoding .............................................................................................................................................. 41 Step 7: Get Results .......................................................................................................................................................... 42 GEOPINPOINT SUITE ACTIVEX SAMPLE NOTE ................................................................................................. 43 GEOCODER.H HEADER FILE VALUES ................................................................................................................ 45 API FUNCTIONS ..................................................................................................................................................... 50 Object Creation and Initialization Functions ......................................................................................................... 51 DMTI Spatial Inc. 15 Allstate Parkway, Suite 400, Markham, Ontario, Canada, L3R 5B4 www.dmtispatial.com 2010 DMTI Spatial Inc. Page 3 Page 3 Address Input Functions ....................................................................................................................................... 52 Geocoding Path Definition Functions ................................................................................................................... 54 Option Functions .................................................................................................................................................. 57 Main Geocoding Functions ................................................................................................................................... 70 Output Functions .................................................................................................................................................. 71 CONCLUSION ......................................................................................................................................................... 82 APPENDIX 1: INTERPRETATION OF RESULT CODE (RCODE) ........................................................................ 83 APPENDIX 2: INTERPRETATION OF PRECISION CODE (PRESCODE) ............................................................ 95 Interpretation