Application Documentation
 
VM Weblocate
Standard Mapping API
 
Version 1.0
 
Last Updated : 27 December 2006
 
Virtual Map (Singapore) Pte Ltd
Solution Division
Block 215 Henderson Road
#03-06
Singapore 159554
Tel: 6272 2538        Fax: 6272 2958
 
Online Geographic Information System
Website            : www.virtual-map.com
Showcase portal : www.streetdirectory.com
 
Disclaimer :
Information in this document, including URL and other Internet Web site references, is subject to change without notice. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or means (electronically, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express permission of Virtual Map.
 
1     Objectives
The objective of this document is to provide an overview of standard mapping API’s which are available for integration by clients and partners. The API’s are hosted by Virtual Map and are available for the following countries
a)     Singapore
b)     Malaysia (KL, JB, Penang)
c)     Thailand : Bangkok
d)     Indonesia : Jakarta
 
2     Introduction
Virtual Map’s (VM) Mapping Application Program Interface (API), can be integrated into website content seamlessly, without additional hardware, software installation and additional browser plug-in at end-user, which may hinder end-user surfing experience.
A basic integration method for website is by passing parameters to the standard VM’s Mapping API.
Following is the Mapping API with a “Postal Code” parameter:
http://test2.street-directory.com/test.php?postalcode=159554&star=1
MAPPING API Parameter
The calling of customized script can either be embedded into your page, or opened in a separate window by mean of pop up page.
Result returned from the Mapping API as follows:
 
 
2     Mapping API Parameter configuration
The Mapping API will display different result depending on the parameter input to the Mapping API. Following is Mapping API is using Postal Code and Star as parameter.
http://test2.street-directory.com/test.php? postalcode=159554&star=1
MAPPING API Parameter
Following are various parameters which may be passed into the Mapping API:
Parameter Explanation Format
ADDRESS    
postalcode Postal Code of map location 6 digit numbers
buildingblockhouse Block unit of map location Text
streetname Street name of map location Text
buildingname Building name of map location Text
TO    
x X coordinate of Map location Number
y Y coordinate of Map location Number
lat Latitude of the Map location Number
lon Longitude of the Map location Number
level Scale of map display, possible value are:
1, 2, 3, 4, 5, 6 which will further discuss.
1 to 6
star Turning on/off indicator of map’s central location 1 = Turn On
0 = Turn Off
Note:
•   Postal Code is the commonly used parameter as it is the simplest way to locate a location. E.g. postalcode=159554
•   Star refers to placing a star indicator in the map of the location.
•   Level refers to the level of zoom of the Map.
There are some examples on the following page showing on how to use some of the commonly used parameter like postal code, level and star.
Examples 1 : Parameter with Postal Code and Star.
http://test2.street-directory.com/test.php? postalcode=159554&star=1
 
MAPPING API Parameter
  The API will return a star indicating the location with postal code 159554, as the parameter for star is turn on.
Examples 2 : Parameter with Postal Code and Star.
http://test2.street-directory.com/test.php? postalcode=159554&star=0
MAPPING API Parameter
  The API will not return star for the location with postal code 159554, as the parameter for the star is turn off.
Examples 3 : Parameter with Postal Code, Star and Level.
http://test2.street-directory.com/test.php? postalcode=159554&star=1&level=4
MAPPING API Parameter
 
Examples 4 : Parameter with Latitude, Longitude and Star.
http://test2.street-directory.com/test.php? lon=103.819187&lat=1.280696&star=1
MAPPING API Parameter
 
The different map levels and their respective map scales are highlighted in the following table.
Level Scale
1 1 : 356955.6091
2 1 : 178477.8045
3 1 : 62649.80991
4 1 : 12284.7769
5 1 : 6142.388451
6 1 : 3071.194226
Note:
Scales used are referenced to hard copy prints. For example for level 6 map, a building of 1 cm width on hard copy, represents a building of 3071.194cm (~30 meter).
 
3     Using The Mapping API
Follow through the following steps to start using Mapping API.
Step 1: Getting the Correct Map URL from the Mapping API.
To get the correct Map of location, use parameter like postal code which is unique. Use the star parameter to display the star to pint point on the actual location as following:
E.g. http://test2.street-directory.com/test.php?postalcode=159554&star=1
Step 2: Incorporate the link to the image tag of the website.
The Blue text is the Map URL from the Mapping API. Incorporate into the website with the image tag to display map image on the website.
Example:
<html>
<head>
<title>Example of Using Mapping API</title>
</head>
<body>
<img src=" http://test2.street-directory.com/test.php?postalcode=159554&star=1">
</body>
</html>
 
Screen Shot of the HTML page generated.
 
4     Reference Implementations
The following URL’s are reference implementations of sites that have deployed similar standard mapping API’s into their website content.
Example Client URL
     
     
 
5     About Virtual Map
Virtual Map (S) Pte Ltd is a technology firm that focuses on developing location-based software and solutions in the Asia Pacific Region. Established in 1999, the company has acquired specialized skills in the area of Digital Map Imaging, GSM, Remote Positioning and Wireless Navigation. Our services are featured at the company’s widely popular portal www.streetdirectory.com.
To meet the LBS demands of different industries, VM manages a portfolio of 7 distinct service lines each leveraging on VM’s core mapping capabilities. This document highlights the capabilities of the company’s online mapping solution: VM Weblocate. For more information please visit www.virtual-map.com.
For service support contact:
Tel: (65) 62722538 [Mon – Fri 9am to 7pm]