Indoor waypoints overview

An indoor waypoint is a location that the requested route must traverse through. The origin and destination of a route are waypoints themselves. Every route must have at least two waypoints: origin and destination.

A route can also have several intermediate waypoints, which are locations between the origin and the destination that the route goes through in the specified sequence.

Intermediate waypoints are specified using the via parameter.

Indoor waypoints components

• Location coordinates - Required
• Place options - Required
• Waypoint options - Optional

Location coordinates

• Location coordinates are the latitude and longitude of a particular place on an indoor map.

Place options

• The two parameters that denote place options are Indoor map id and the Corresponding level id

Waypoint options

• There are two types of intermediate waypoints
  • A stopover point, which is a waypoint at which the journey stops for some time(optional) before it continues and it creates a separate section for each waypoint route. This is the default setting for all intermediate waypoints. Can be enabled explicitly through the passThrough=false option.
  • A passthrough point, which is a waypoint that doesn't stop the journey, and changes the shape of the route only. Enabled through the passThrough=true option.
• Additionally user can pass stopover time by using stopDuration waypoint option.
• Setting passThrough=true with stopDuration value will be an invalid combination for a particular waypoint.

Sample denotions of an indoor waypoint

• origin=52.5306348,13.3848528;indoorMapId=YOUR_INDOOR_MAP_ID;levelId=LEVEL_ID
• destination=52.5306348,13.3848528;indoorMapId=YOUR_INDOOR_MAP_ID;levelId=LEVEL_ID!stopDuration=60
• via=52.5306348,13.3848528;indoorMapId=YOUR_INDOOR_MAP_ID;levelId=LEVEL_ID!passThrough=false!stopDuration=60
• via=52.5306348,13.3848528;indoorMapId=YOUR_INDOOR_MAP_ID;levelId=LEVEL_ID!passThrough=true

Route through intermediate waypoints

To add a waypoint to a route, specify it using the via parameter in your request.

When you add stopover via waypoints (passThrough=false), the route is divided into the following sections:

1. From the origin to the first via
2. To any subsequent via, for every point in the requested order
3. From the last via until the destination.

When the waypoints don't introduce stops (passThrough=true), the API doesn't split the route into sections.