Render Map service

Render Map service

Overview

http://209.85.129.132/search?q=cache:bRQvQTswwf0J:www.isharemaps.com/index.php/iShareMaps-On-Demand/Web-Services-Geocoder.html+how+to+render+a+map+services&cd=8&hl=en&ct=clnk

The Render Map service allows you to return a map based on specific criteria parsed in the input string. This information may be X and Y co-ordinates, map boundary, zoom level etc. This service may be used in conjunction with the previously defined Geocode service as once an address has been geocoded (has X and Y co-ordinates) then the positional information can be used to display a map showing the relevant address information.

The Renderer can be accessed via the URL below.

http://www.isharemaps.com/on_demand/v2/renderservice.php

Functions Specification

Name: GetMapImage

This function will get a map according to the ‘MapSpecification’ structure

Input:        MapSpecification

Output:      MapImage

Structure Definitions

This section defines all of the structures that are used in the Geocoding and Map Render web services. These structures are used by the web services as input or output.

AddressResult

This structure stores the parsed address information from raw address input.

Field	Type	Description
address	string	Street address part
City	string	City
County	string	County
country	string	Country
postcode	string	Postcode

 

FormatAddressCollection

It is a collection of the formatted address defined above, which could be used to pass a set of formatted address to the web service for batch geocoding.

Field	Type		Description
array	AddressResult	An array of the pre-defined AddressResult structure

 

LocationResult

This is the structure to store the geocoding result.

Field

Type

Description

EntityName

string

Location result’s entity name (display name)

x

string

X coordinate (longitude or BNG depending on coordinate system used)

y

string

Y coordinate (latitude or BNG depending on coordinate system used)

z

string

Zoom value

score

string

The score represents the geocode matching score and is composed of a letter (A-C) followed by a percentage score e.g. A0.nn. The higher the score, the more accurate the result.

The letter scores have the following meaning:

Prefix	Description
A	Postcode level - A match is found in the UK postcode database. This is the most detailed level
B	UK city level - A match is found in the UK city database.
C	World-wide city level - A match is found in the world-wide city database.

 

LocationResultCollection   

As its name indicates, it is a collection of the LocationResult which will be used to return batch geocoding result.

Field	Type	Description
Array	LocationResult	An array of the pre-defined LocationResult structure

 

CountryAbbr

A structure to store the country abbreviation and its corresponding full name.

Field	Type	Description
Abbr	string	Country abbreviation, like UK, USA
fullName	string	Country full name, like ‘United Kingdom’

 

CountryAbbrCollection

A collection of the above mentioned structure

Field	Type	Description
Array	CountryAbbr	An array of the CountryAbbr structure. Would be used to store all the country abbreviations and names when using function GetCountries.

 

RawAddressCollection

Actually a string array to store multiple lines of raw addresses.

Field	Type	Description
array	String	Array of strings

 

SingleRawAddressSpec

Contains single raw address and other geocoding options (like threshold value, returned result number etc.).

Field	Type	Description
rawAddress	string	The raw address string (comma separated)
count	int	How many results you want the web service to return
threshold	double	Threshold value. Raise this value will filter non-
licensekey	string	License key acquired when registering
coordsys	int	Coordinate system used:   0: Long/Lat   1: British National Grid

 

MultipleRawAddressSpec

Similar to previous SingleRawAddressSpec except that it contains multiple raw addresses.

Field	Type	Description
rawAddressCollection	RawAddressCollection	Array of raw addresses string
threshold	double	Threshold value
licensekey	string	Licensekey
coordsys	int	Coordinate system

 

SingleFormatAddressSpec

This structure contains a formatted address and other geocoding options.

Field	Type	Description
formatAddress	AddressResult	Formatted address
Count	int	The number of results we want the web service returns
threshold	double	Threshold value
licensekey	string	License key acquired when registering
coordsys	int	Coordinate system

 

MultipleFormatAddressSpec

This structure contains multiple formatted addresses and other geocoding options. 

Field	Type	Description
formatAddressCollection	FormatAddressCollection	Formatted address collection
threshold	double	Threshold value
licensekey	string	License key
coordsys	int	Coordinate system

 

MapSpecification

MapSpecification will be used as the input for retrieving the map.

Field	Type	Description
mapView	MapViewDefinition	MapView which defines the map to retrieved
licensekey	string	License key acquired
width	int	Map width (in pixel)
height	int	Map height (in pixel)
source	int	From where to get the map from (MapPoint or MapServer), could be the following values:   0: System determine automatically (according to zoom value)   1: MapPoint   2: MapServer

 

MapViewDefinition

It will be used both for input (when specifying what map we want to get) and output (stores the basic information for the returned map).

Field	Type	Description
x	double	Central point longitude
y	double	Central point latitude
minX	double	Minimal longitude of the map boundary
minY	double	Minimal latitude of the map boundary
maxX	double	Maximum longitude of the map boundary
maxY	double	Maximum latitude  of the map boundary
zoom	double	Zoom (scale) value, will be used in combination with ‘x’, ‘y’

MapViewDefinition can either define a map through central point long/lat + zoom value, or via the map boundary. If minx/miny/maxx/maxy values are both 0 then the webservice will render the map according to long/lat+zoom value, otherwise it will generate the map with the designated map boundary.

 

MapImage

This structure will be used to store the result returned by render service.

Field	Type	Description
mapView	MapViewDefinition	The map view for the generated map
url	string	Url for the map generated