Version 0.50.0 (2017-04-28)

Frequently Asked Questions

Getting started

What browsers are supported by the API?

How do I start a new application?

How do I migrate an existing MapAPI application to the KartenVerzeichnisAPI?

What is a VNR and PNR, and how do I get them?

How do I report a bug?

Search functionality

What does my search engine have to support to be used by this API?

How do I add my search engine to the KartenVerzeichnisAPI?

Customizing API components

Is it possible to customize the print view?

Answers

What browsers are supported by the API?back

Generally you should be able to use any current desktop browser. The API is tested in these browsers:

BrowserVersion
Mozilla Firefox3.0+
Apple Safari3.0+
Google ChromeCurrent version
Opera10.0+
Microsoft Internet Explorer6.0+

How do I start a new application?back

Have a look at our example page. The page can be customized in various ways to match your requirements. For a start you can use the mock search engine which generates a configurable number of random search hits every time you click the search button.

When you are done just click the button "Show Example Page" to see the result and use the source code as an example or the base for your own application.

How do I migrate an existing MapAPI application to the KartenVerzeichnisAPI?back

This is easy. The KartenVerzeichnisAPI is an extension to the MapAPI. The main class SearchableMap basically extends IWMap. All functions and events of the IWMap class can be used without modifications to your code.

Just import the MapAPI and the KartenVerzeichnisAPI, switch your map object to a SearchableMap and start using the new classes, functions and events.

To import the APIs add this code to your page:

				<script type="text/javascript" src="http://iw.mapandroute.de/KartenVerzeichnisAPIjs/lib/jquery-1.4.2.min.js"></script>
				<script type="text/javascript" src="http://iw.mapandroute.de/MapAPI-1.0/js/mapping.js/js/mapping.js?vnr=0&pnr=2"></script>
				<script type="text/javascript" src="http://iw.mapandroute.de/KartenVerzeichnisAPI/js/search.js"></script>
				
				<link rel="stylesheet" type="text/css" href="http://iw.mapandroute.de/KartenVerzeichnisAPI/static/css/default.css"/>
			

What is a VNR and PNR, and how do I get them?back

VNR and PNR are numbers used to identify a customer and product. Please contact us for details.

How do I report a bug?back

Just send us an e-mail to mapapi@infoware.de. Please include the following details:

What does my search engine have to support to be used by this API?back

Your database must be able to do spatial searches defined by a polygon of four WGS 84 coordinates. Please keep in mind this polygon is not necessarily a rectangle if you want to support birds view images, too.

Other required parmeters include the search keyword, the number of hits to load, to and from indices to support paging, and the ordering (by distance or alphabetical).

How do I add my search engine to the KartenVerzeichnisAPI?back

If your database matches the requirements (see above) just contact us. We will provide a connector to your system and configure the API to use your database for search queries.

Is it possible to customize the print view?back

Yes, there is a template parameter for SearchableMap.print(). Specify an URL to a HTML page with your print view here.

Use the placeholders ${map}, ${copyright} and ${content} in this page to indicate where the map, the copyright notice and the dynamic content (e.g. hit list or driving directions) should be inserted.

Example: