The Route Resource
This resource provides the functionality for the route and route marker representation (no calculation included) on a map image. Multiple routes can be shown on same map and the color and thickness of the drawn route line can be customized.
It supports also different map schemes, image sizes; image formats as well as zooming out from automatically calculated zoom level.
Routes can be drawn as polylines connecting waypoints specified in the request paramters (latitude and longitude pairs). The route waypoints are connected together with a line in the order they are given.
The zoom level for the displayed image is determined automatically using the route information and display size (width and height parameters). A given zoom level is only considered if it is smaller than the calculated one to provide a wider view of the map.
Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.
|ctr||Geo Coordinate|| |
Map center point geo coordinate. If the position is on the border of the map, the dot might be cropped.
Note: For Basic Map: If center point is not given in the request, the position parameter will be used as the center point, if no POIs (parameter
Note: For Route: Using this overrides the automatically calculated route center point. Using this also enables free zoom level definition i.e. also zooming in (not only zooming out) is possible from automatically calculated zoom level.
|ectr||Encoded Geo Coordinate|| |
Encoded equivalent of map center point geo coordinate parameter
Image format. It is possible to request the map image in following formats:
Note: For PNG8 images some of the colors may differ compared to full color images so use it with precaution.
Note: For SVG: parameters
Note: For Roadsign: Only PNG format is available.
Note: For Companylogo: Only PNG and SVG formats is available.
Result image height in pixels, maximum 2048. Height and width parameter can be provided independently, i.e. there is no need to enter both to resize the image.
Line color. When presenting only a single route or area/region, the index 0 of the parameter is not required i.e. plain
Note: For Region: Outline color of area/region. It is used only if fill color
Note: For Route: Route line color.Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the color of the last available indexed line color parameter before the gap.
Note: For Turning Point: This is the arrow line color. Use parameter
Line width. When presenting only a single route or area/region, the index 0 of the parameter is not required i.e. plain
Note: Valid values are from 1 to 20.
Note: For Region: Outline width of area/region. Outline width is used only if outline color lc for corresponding index is given, and fill color fc for corresponding index is not given.
Note: For Route: Route line width. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the width of the last available indexed line width parameter before the gap. The final line width consists of this line width and the additional border (shadow) line width (one pixel on both sides of the line) but only if the border line color is not set fully transparent for the route line with similarly indexed parameter sc.
Note: For Turning Point: Arrow line width.Use parameter lw without index for Turning Point since it does not support the indexing i.e. multiple line widths. The final line width consists of this line width and the additional border (shadow) line width (one pixel on both sides of the line) but only if the border line color is not set fully transparent for the arrow line with parameter sc.
Note: For Routing: Since only one route is supported only one value will be used. Therefore
|m,m0,m1,...||Geo Coordinate List|| |
List of geocoordinates for route waypoint marker icon group.
Common marker labeling type for all marker groups can be defined with parameter
Note: The marker points are meant to be along the considered route, preferably they should be a subset of the points given in the associated route parameter. This is not required for markers to be shown, but to see the markers they must be near enough the route area i.e. markers do not affect the automatic zoom level calculation or shown bounding box and can therefore go out of the image.
Fill color for route markers. This can used to define common default fill color for all route markers (without index) or route marker group specific fill color (with index). If no fill colors are available, system default fill color will be used for all markers. Marker group index having no fill color defined will use the default.
Map label language.
If the map language is locked on the server config, this parameter (or alternatively the Accept-Language HTTP header) has no effect, i.e. the locked map language is used. The following MARC three-letter language codes are supported currently (the language codes are case insensitive):
Note: The languages listed in this document might not be up to date as they are dependant on the specific configuration on the server.
Route marker labeling type.
Route marker theme.
Text color for route markers.
Text font size for route markers between 8-30.
Flag to avoid having cropped labels on the map. If the parameter is present in the request, the labels that do not fit completely on the image requested will not be on the map, if the parameter is not present, the default behavior will apply, that is, showing the labels even if they are cropped.
Flag for hiding copyright information on the map.
Note: When this parameter is used, parameter
Flag for hiding route icons (markers). Does not affect POIs.
|poi||Geo Coordinate List|| |
List of geo coordinates for Points of Interest. Points are shown on map with markers if flag
Note: For Basic map: When this parameter is used, parameters
Note: For Route: POI markers are always shown, but only if they are near enough the route area i.e. POI markers do not affect the automatic zoom level calculation or shown bounding box and can therefore go out of the image.
Note: This parameter can not be mixed with parameter
Default fill color for POI markers. This can used to define common default fill color for all POI markers. If no default fill color is available, system default fill color will be used.
POI marker labeling type.
POI marker theme.
Default text color for POI markers. This can used to define common default text color for all POI markers. If no default text color is available, system default text color will be used.
Default text font size for POI markers, valid range is between 8-30. This can used to define common default text font size for all POI markers. If no default text font size is available, system default text font size will be used.
Single extended POI marker characteristics as fields. Fields that can be provided are (in following order):
Resolution to be used. Only allows three values:
Note: When using this parameter the size of the logo will be adjusted to match the resolution.
Note: Please note that mobile schemes can only be used with 250 ppi value, as mixing mobile and non mobile parameters is not allowed.
Geopolotical View to be used. Use this parameter to render the map with boundaries based on international or local country views. Not specifying the parameter results in a default view of boundaries. If the parameter is specified and the view is supported, boundaries of the selected country view are being shown. The list includes but is not limited to:
Image compression quality in percentage between 1-100, default is 85 if not specified. The parameter takes effect only if JPEG image format is used.
|r,r0,r1,...||Geo Coordinate List|| |
The route waypoints, given as list of geo coordinates.
Note: For Route: Routes have to be distinguished by indexes in the parameter name when showing multiple routes on same map i.e.
Note: For Turning Point: Only fixed index 0 i.e.
Note: For Turning Point use parameter
Note: For Route: The border colors have to be distinguished by indexes when showing multiple routes. The index number is used for linking the border color to similarly indexed route. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the color of the last available indexed border color parameter before the gap. When presenting only a single route, the index 0 of the parameter is not required i.e. plain
Note: For Routing: Since only one route is supported only one value will be used. Therefore
ID of service owner specific copyright. Shows service specific additional copyright information together with map data copyright. The value must be a valid ID/key of a pre-configured service specific copyright i.e. the parameter value itself is not shown on map.
Note: This parameter is ignored if flag parameter
Map style type. All available styles are defined by Map view server of the Map Image API. The list includes but is not limited to:
Map scheme type. All available schemes are defined by Map view server of the Map Image API API. Currently this API supports the following set of schemes:
An URL-encoded Base64 string of typically, but not guaranteed to be 24 bytes generated based on the user's app ID and received after the registration process of the application.
Result image width in pixels, maximum 2048.
Note: For Roadsign and Companylogo: minimum is 24, maximum is 256.
Zoom level for the map.
Note: When the request contains parameters having geo coordinate lists or multiple parameters having single geo coordinate pair as value, the zoom level is automatically calculated. In these cases the requested zoom level is applied only if it happens to be smaller than the automatically calculated one i.e. zooming out is desired.
Note: For Route: When the request contains also center point (
Note: For levels below 5, the width and height cannot be 1024 or higher.
Note: For Tilt Maps: For zoom levels over 5, the ceiling of