How To: Embedded View - URL Parameters

RSS
Modified on 2017/10/19 16:36 by Ryan Categorized as How To
By default, the tracking platform will be initialized in live mode with the road map type and fit to show all assets. The behavior and characteristics of this view can be changed via the following query string parameters, however.

Global Parameters

ParameterValuesBehavior
defaultMode
  • live
  • history
Changes the default view mode of the tracking view to the specified value. Note that anonymous users have history by default, authenticated users live.
defaultMapType
  • road (default)
  • satellite
  • terrain
  • openstreetmap
Changes the default map type of the tracking view to the specified value. Note that the 'terrain' maps are unable to be stylized (the user's preferences for country names, roads, etc will be ignored).
disablePositionPopup
  • true / 1
  • false / 0 (default)
Setting this to 'true' or '1' will disable the position popups for when the asset is selected via 'showAssetId' or 'showAssetUniqueId'. It will also prevent any new "live" positions from popping-up while the asset is being followed.
defaultZoom1-20 (14 by default)The Google Maps zoom level that will be the default zoom for selected positions. Note that the zoom level will not change for the user if they are already zoomed in closer. 1 = broadest zoom, 20 = tightest zoom
minimumZoom1-20 (20 by default)The Google Maps zoom level that will be the absolute furthest in the zoom will be by default when showing all current positions. Users can still zoom in to the Google Maps zoom limit (20). 1 = broadest zoom, 20 = tightest zoom
enableLayers
  • iridium
  • radar
  • oil
  • maritime
  • traffic
  • weather
  • clouds
  • orbcomm
  • inmarsat
  • globalstar
Automatically enables the specified layers on the map. To enable multiple layers, simply separate them with a comma in the querystring.
disableLayerSelection
  • true / 1
  • false / 0 (default)
Setting this to 'true' or '1' will remove the Layers selection from the map.
disableMapTypeSelection
  • true / 1
  • false / 0 (default)
Setting this to 'true' or '1' will remove the Map Type (Map/Satellite/Terrain/OpenStreetMap) selection from the map.
disablePanels
  • true / 1
  • false / 0 (default)
Setting this to 'true' or '1' will remove the Alerts & Events panel from the bottom of the map.

Example URLs

https://tracking.redportglobal.com/Track?defaultMapType=satellite
https://tracking.redportglobal.com/Track?defaultMapType=terrain&disablePositionPopup=1
https://tracking.redportglobal.com/Track?defaultMapType=road&enableLayers=iridium,radar

Anonymous Users

Anonymous users are those who do not require a password to view their assigned assets. The short-cut to automatically login as an anonymous user is:
https://tracking.redportglobal.com/Anonymous/userName

For example, if we had an anonymous user with a username of "public", the URL would be:
https://tracking.redportglobal.com/Anonymous/public

By default, links to anonymous views will be put into the history view that will show two days worth of position information for their assigned assets. The behavior and characteristics of this view can be changed via the following query string parameters, however.

Anonymous Users Parameters

Note that all of the Global Parameters listed above also apply to Anonymous Users URLs

ParameterValuesBehavior
daysintegerThe number of days worth of position history to show. This is based on the last submitted position for the tracking client.
from datetimeThe starting date from which to show position history. Note that including this parameter overrides the 'days' parameter above.
todatetimeThe ending date from which to show position history.
showAssetUniqueIdstringBy passing a valid "Unique Id" of an asset assigned to the anonymous account, the default view will be the 'live' view instead of the 'history' view and the asset will automatically be followed with its latest positions highlighted.
showSidePanel
  • true / 1
  • false / 0 (default)
Whether or not the side panel is shown. By default, it is hidden for anonymous users and shown for normal users.

Example Anonymous URLs

https://tracking.redportglobal.com/Anonymous/public?days=10
https://tracking.redportglobal.com/Anonymous/public?from=1/1/2012&to=1/30/2012
https://tracking.redportglobal.com/Anonymous/public?from=1/1/2012
https://tracking.redportglobal.com/Anonymous/public?showAssetUniqueId=IMEI&disablePositionPopups=1


Safari Users

Note that Safari has a strict policy against third-party cookies that is enabled by default. Under this policy, it is not possible to embed the anonymous view in an iframe. For such users it is recommended that a popup window be used.