03 – Query params

Tip! Check our Quickstart guide to start integrating Situm Map Viewer in your webpage / kiosk

Situm Map Viewer offers a wide set of query parameters that can be used to adapt it to any needs. As an example, you may use an URL like:

https://map-viewer.situm.com/?lng=es&navigation_from=100593&navigation_to=92993&buildingid=7033&floorid=14468

The following table summarizes the most important query params:

Query paramDescriptionDynamic / Static
emailCurrent user emailStatic
apikeyCurrent user API KEY. Use this endpoint or this Dashboard panel to get your api keys.Static
buildingidIndicates the selected building identifier. Use this endpoint to get your buildings ids.Dynamic*
flooridIndicates the selected floor identifier. Use this endpoint to get your floors ids.Dynamic
poiidIndicates the selected POI identifier. Use this endpoint to get your POIs ids.Dynamic
navigation_toIndicates the destiny POI identifier in a route.Dynamic
navigation_fromIndicates the origin POI identifier in a route.Dynamic
lngSets the language of the UI. Supported values: en (English), es (Spanish), fr (French), pt (Portuguese), it (Italian), tr (Turkish), ar (Arabic) and he (Hebrew). If not provided, the browser locale will be used if available (fallback language is English).Static
rtlReceives a boolean that when it’s true make texts and layout elements adapt to right to left languages. If not specified, it is false by default.Static
lockCameraToBuildingThis boolean parameter controls the user’s exploration privilege within the canvas or world map. When set to true, it restricts navigation to the current building, limiting movement within its boundaries. Conversely, when set to false, users can freely explore the entire world map without restrictions. If not specified, it is true by default.Static
fpIndicates the POI identifier to be designated as a fixed POI. A fixed Point of Interest (POI) is a specific location identified by the provided identifier. Once designated as a fixed POI, this location maintains a consistent presence on the map, regardless of visibility settings or other configurations. It serves as a permanent and unchanging point for reference or focus.Dynamic

*While using the Map Viewer, some query params will be dynamically updated based on the actions performed by the user: this way, you may share the current state just by sharing the URL.

Email & apikey #

These two parameters are used together: they allow you to use your account and access to your organization’s available buildings.

https://map-viewer.situm.com/?email=<your_email_here>&apikey=<your_api_key_here>

buildingid & floorid #

These two parameters are used together: they trigger the display of the map in the specified floor that belongs to the specified building.

https://map-viewer.situm.com/?buildingid=7033&floorid=14467
Building and floor visualization

poiid #

This parameter centers the view on the specified POI and shows the available information at the superior left corner. It usually goes with buildingid and floorid, which will autocomplete if missing.

https://map-viewer.situm.com/?poiid=47204
POI visualization

navigation_to #

Situm Map Viewer allows you to ask for a route to different places: the destination POI is specified on the navigation_to query param. This parameter is always recommended to be used in combination with poiid.

https://map-viewer.situm.com/?buildingid=7033&floorid=14467&navigation_to=47204
Route destination selected

navigation_from #

When the destination is selected, only the origin is missing to finish the route calculation. To do this we have navigation_from, which specifies the POI where you are expected to be and you are starting to walk towards the destination.

https://map-viewer.situm.com/?navigation_from=47196&buildingid=7033&floorid=14467
Route origin selected

lng #

Use lng query param to force the User Interface to be on a specific locale language

https://map-viewer.situm.com/?lng=es&poiid=47196&navigation_from=47196&navigation_to=47204&buildingid=7033&floorid=14467

rtl #

When it is true, the map Viewer will mirror the elements of the interface to adapt the UI to right to left languages. It is commonly used with lng=ar or lng=he.

https://map-viewer.situm.com/?rtl=true&buildingid=7033&floorid=14467
Right to left layout

fp #

This parameter designates the specified POI as a fixed POI, guaranteeing its prominence on the map and establishing it as the origin for all route computations. It overrides the custom field hide when it is set to on_map, ensuring the fixed POI is always displayed on the map.

https://map-viewer.situm.com/?fp=516721&lng=en&buildingid=7033&floorid=14467
Fixed POI visualization

Subscribe to our newsletter

BASIC INFORMATION ON DATA PROTECTION

Data controller: SITUM TECHNOLOGIES, S.L.
Contact: Data controller: situm@situm.es
Responsible for protection: dpo@situm.es
Purpose and legal basis: To manage the sending of SITUM newsletters only with consent.
Legitimation: Express consent of the interested party.
Recipients: The data will not be passed on to third parties with the exception of legal obligations.
Retention period: As long as the interested party remains subscribed to the newsletter (a link to unsubscribe will be available in each newsletter sent by Situm).
Rights: The interested party may at any time revoke their consent, as well as exercise their rights of opposition, access, conservation, rectification, limitation, deletion of data and not be subject to a decision based only on automated data processing, by writing to SITUM at the addresses indicated.
Additional Information: You can consult additional and detailed information on Data Protection in our privacy policy.

Please, download your copy here

Thank you for downloading our whitepaper. Please do not hesitate to contact us if you would like to know more about how our solutions can help your business. Download whitepaper


Close window