API Reference

A Plans Embed API iframe URL must be of the following form:

https://api.locatrix.com/plans-embed/v1/plans?parameters

Certain URL parameters are required while some are optional. As is standard in URLs, all parameters are separated using the ampersand (&) character. The list of parameters and their possible values are enumerated below.

Parameter	Required	Description
viewerToken	yes	A viewer token obtained from the Locatrix ESAPI, which contains the plan identity to be loaded and authentication to do so.
icons	no	A comma-separated list of icon types that should be shown in the generated image (if any of those icons are present on the plan). For example, icons=mcp,hyd,extinguisher_dcp. Icons not included in the list will be hidden. If not specified, defaults to showing all icons in the plan.
layers	no	A comma-separated list of layers and layer groups that should be enabled in the generated image. For example, layers=structure,interiorZone,leaderLineIcon. A list of available layers and layer groups can be found at Layers and Layer Groups . Layers not included in the list will be hidden. If not specified, defaults to showing all layers normally visible on evacuation signs.
interactive	no	Whether the viewer should be interactive. interactive=false will disable camera movement and controls. If not specified, defaults to interactive=true.