Mapsolute GmbH. MapTP Geocoder. Interface Reference Manual. Last update: 02 February Düsseldorfer Str. 40a Eschborn

Size: px

Start display at page:

Download "Mapsolute GmbH. MapTP Geocoder. Interface Reference Manual. Last update: 02 February Düsseldorfer Str. 40a Eschborn"

Antonia Carter
5 years ago
Views:

1 MapTP Geocoder Last update: 02 February 2006 Mapsolute GmbH Düsseldorfer Str. 40a Eschborn Telefon: +49 (0) 6196 / Telefax: +49 (0) 6196 / info@mapsolute.com

2 TABLE OF CONTENTS INTERFACES...3 HTTPService-Interface...3 Geocoding Version Geocoding Version 3 (with alternatives)...4 Geocoding version 4 (with alternatives)...6 MapTPService-Interface...7 Geocoding Version 1...Fehler! Textmarke nicht definiert. Geocoding Version 2 (with alternatives)...7 Geocoding version 3 (with alternatives)...8 Terms...9 Quality and Similarity...9 Type (optional input)...9 Similarity (optional input)...9 Bounds (optional output)...9 REQUIREMENTS AND PROVIDED MAPS...9 Page 2/9

3 Interfaces HTTP Service-Interface The HTTP-Service Interface is used by HTTP-Clients for communication with the MapTP- Geocoder. Geocoding Version 2 Normally HTTP Service Interface Base Url should be geocode. INPUT: Option Comment Mid Map24-UserID. Pwd Password. s Street. csd City district. cty City. cns State. cn Country. pc Postcode. sim (optional, default 0) overwrites the server simsimilarity value in the ini file for this request. typ (optional, default 0) the value 2 returns only real settlement points. Suppresses pseudo zips and postcode centroids. enc Input and output encoding. If no option giving use default iso character encoding. Values utf8 or utf-8 for utf8 in/out character coding. list Returns al house numbers of the searched street. With options x and y the result list is sorted by distance of coordinates. The limit of the list depends of server configuration. x, y See list option. OUTPUT (description of each line returned): Row Comment 1 X-coord. 2 Y-coord. 3 Quality (-7 to +7). Page 3/9

4 4 Street & house number. 5 Postcode. 6 City & city-add on 1. 7 State. 8 Country. Example: Zeil Frankfurt Am Main Innenstadt Hessen DE Geocoding Version 3 (with alternatives) Normally HTTP Service Interface Base Url should be gmmulti. INPUT: Same as version 2; with optional parameters name comment max (optional) max. number of addresses the answer should contain. out (optional) 0 returns result in columns with delimiter for each field. 1 like 0 with header line. OUTPUT: Same as version 2; with small changes. Row 3 (quality) now contains the value similarity and is separated from quality by a semicolon. quality; similarity OUTPUT: Result in columns (description of each column returned): Col Name Comment 1 example: Frankfurt am Main city= Frankfurt city-add-on= am Main Page 4/9

5 1 X X-coord. 2 Y Y-coord. 3 QUALITY Quality (-7 to +7) 4 SIMILARITY 0.0 up to STREET Street & house number 6 ZIP Postcode 7 CITY City & city-add on 2 8 DISTRICT City district 9 COUNTY County 10 STATE State 11 COUNTRY Country 12 X0 Top left bound X 13 Y0 Top left bound Y 14 X1 Bottom right bound X 15 Y1 Bottom right bound Y 16 VARIANCE Variance 17 OFCODE Official Code Another change is, that now more than one record is returned. One record contains 8 rows (for results in rows), or one row (for results in columns). Example: ; Frankfurt Am Main Hessen DE ; Frankfurt Am Main Altstadt Hessen DE Example output in rows (out=1) and settlement points (typ=1): X Y QUALITY SIMILARITY STREET ZIP CITY DISTRICT COUNTY STATE COUNTRY X0 Y0 X1 Y1 VARIANCE OFCODE Frankfurt Am Main Frankfurt Am Main Hessen DE example: Frankfurt am Main city= Frankfurt city-add-on= am Main Page 5/9

6 The first record returned is the best match, followed by remaining records in descending order. ATTENTION: The max. number of addresses the answer contains is limited to 100. Any parameter max value greater than this will be ignored. Geocoding version 4 (with alternatives) Normally HTTP Service Interface Base Url should be geo-0. INPUT: Same as version 2 OUTPUT: The output-format has changed from 8 rows to only one row for each address. The columns of this row are separated by. Example: Column Comment 1 X-coord. 2 Y-coord. 3 Quality 4 Smilarity 5 Street & house number 6 Postcode 7 City & city-add-on 8 District 9 County (Kreis) 10 State (Bundesland) 11 Country (Land) Zeil Frankfurt Am Main Innenstadt Frankfurt Am Main Hessen DE Zeil Frankfurt Am Main Innenstadt Frankfurt Am Main Hessen DE Page 6/9

7 MapTP Service-Interface The MapTP-Service Interface is used by MapTP-Mapping-Clients for communication with the MapTP-Geocoder. Geocoding Version 2 (with alternatives) Normally service-id should be "2". INPUT: ATTENTION: column Name comment 0 Qlt Match quality 1 Mid Username 2 Pwd Password 3 s Street 4 s2 Street 2 5 csd City-district 6 cty City 7 cns State 8 cn Country 9 pc Postcode 10 pac Postal-add-on-code 11 ip 12 host 13 referrer 14 maxanswer (optional) max. number of addresses the answer should contain 15 sim (optional, default 0) overwrites the server simsimilarity value in the ini file for this request 16 typ (optional, default 0) the value 2 returns only real settlement points. Suppress pseudo zips and postcode centroids. Generally the match quality is set to 1. At value one, the Geocoder will match to housenumber values, where available. At value 2, the match will be to street level, and value 3 will return a city match. The allowed ranges of values are 1 to 7. OUTPUT: column Name type comment Page 7/9

8 0 Size INT 1 X FLOAT_ARR X-coord. 2 Y FLOAT_ARR Y-coord. 3 Quality INT_ARR Quality 4 similarity FLOAT_ARR Similarity 5 Street STRING_ARR Street & housenumber 6 Zip STRING_ARR Zip 7 City STRING_ARR City & city-add-on 8 district STRING_ARR District 9 State STRING_ARR State 10 country STRING_ARR Country 11 x0 FLOAT_ARR Top left bound x 12 y0 FLOAT_ARR Top left bound y 13 x1 FLOAT_ARR Bottom right bound x 14 y1 FLOAT_ARR Bottom right bound y 15 variance FLOAT_ARR Variance ATTENTION: Always check the size field!!!! Only if the value is greater then zero, will record arrays are available. Geocoding version 3 (with alternatives) Same as version 2; with additional output parameters (state & county). Normally service- ID should be "3". OUTPUT: column name type comment 0 size INT 1 x FLOAT_ARR X-coord. 2 y FLOAT_ARR Y-coord. 3 quality INT_ARR Quality 4 similarity FLOAT_ARR Similarity 5 street STRING_ARR Street & housenumber 6 zip STRING_ARR zip 7 city STRING_ARR City & city-add-on 8 district STRING_ARR District 9 county STRING_ARR County (Kreis) 10 state STRING_ARR State (Bundesland) 11 country STRING_ARR Country (Land) 12 x0 FLOAT_ARR Top left bound x 13 y0 FLOAT_ARR Top left bound y 14 x1 FLOAT_ARR Bottom right bound x 15 y1 FLOAT_ARR Bottom right bound y 16 variance FLOAT_ARR Variance Page 8/9

9 Terms Quality and Similarity The quality in the output stays for the kind (Housenumber, Street, City, etc.) of the matched object. The Values are: 0 = error; nothing matched. 1 = house number. 2 = street counterpoint. 3 = city with postcode, or postcode. 4 = district without postcode. 5 = city without postcode. The similarity is a value in percent between the input and the output fields. The value is calculated from the similarity of the field s postcode, city and street. The request Eschborn returns 3;100 (quality 3, similarity 100%). The request Eschbbborn returns 3;86.5. Type (optional input) Requests with type=1 returns only one entry for each located city or district. The coordinates are always settlement centroids. Requests with type=2 returns the city and all districts for each located city or district. The coordinates are always settlement centroids. The default value type=0 return all entries of the located city or district, settlement points and postcode centroids. Similarity (optional input) Requests with sim=0 using the default server similarity (normally should by 43) for geocoding. Any other values from 1 to 100 overwrite the default similarity in percent for this request. This is useful to got exact results from the server (sim=75). Bounds (optional output) City and street quality responses contain valid bounds. The bounds are the bounding box of the object (city, district or street). In case of very small cities or districts, the bounds could by invalid (zero). Requirements and Provided Maps The Geocoder Service uses a Microsoft Access Database. Currently provided Maps: - Teleatlas - Navteq - AND Page 9/9

Custom Location Extension

Custom Location Extension User Guide Version 1.4.9 Custom Location Extension User Guide 2 Contents Contents Legal Notices...3 Document Information... 4 Chapter 1: Overview... 5 What is the Custom Location