Azure Maps Wayfinding Service (preview:2022-09-01)

2025/10/06 • 1 deleted methods

Wayfinding_GetPath (removed)
Description :  **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools. The Wayfinding Service API is part of Creator, and adheres to the [Open Geospatial Consortium](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) standard and uses indoor maps data from the routeset to calculate the best path between two locations within the same facility.
Reference :  Link ¶

⚼ Request

GET:  /wayfinding/path
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
routesetId:
{
Description: The ID of the routeset to query from. ,
Required: True ,
}
string ,
facilityId:
{
Description: The identifier of the facility within the routeset where to find the path. ,
Required: True ,
}
string ,
fromPoint:
{
Description: The path origin point in the following format: {latitude},{longitude}. ,
Required: True ,
}
string ,
fromLevel:
{
Description: The path origin level. ,
Format: int32 ,
Required: True ,
}
integer ,
toPoint:
{
Description: The path destination in the following format: {latitude},{longitude}. ,
Required: True ,
}
string ,
toLevel:
{
Description: The path destination level. ,
Format: int32 ,
Required: True ,
}
integer ,
avoidFeatures:
{
Description: To avoid certain types of connectors in the resulting path. Can be specified multiple times in one request, for example, '&avoidFeatures=elevators&avoidFeatures=escalators'. ,
Required: False ,
}
array ,
minWidth:
{
Description: The minimum width (in meters) of openings in the searched path. For example, if you specified a minimum width of 0.85, the searched path will avoid openings less than 85 centimeters wide. Note: by using this value, the resulting path points will be buffered from walls and other vertical obstacles by half of the width provided. ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
noResultExplanation:
{
Description: In the event that no paths are found, the `paths` array will be empty. If the reason no paths were found can be determined, this property will provide an explanation why. ,
Enum:
{
NoExplanation: Default value provided when a result is returned or it wasn't possible to determine why a path wasn't found. ,
}
,
Required: False ,
}
enum ,
paths:
{
Description: An array of wayfinding path results. An empty array will be returned if no results were found. ,
Required: False ,
}
[
{
lengthInMeters:
{
Description: The path length, in meters, of the entire path. ,
Required: False ,
}
number ,
timeInSeconds:
{
Description: The path total time, in seconds, to travel between the origin and the destination when following this path. ,
Format: int64 ,
Required: False ,
}
integer ,
legs:
{
Description: The different travel sections of this path. ,
Required: False ,
}
[
{
mode:
{
Description: The leg mode of traversal for this leg. It can be default (all on the same level), elevators or stairs when moving vertically between levels. ,
Required: False ,
}
string ,
lengthInMeters:
{
Description: The leg length, in meters, of this leg. ,
Required: False ,
}
number ,
timeInSeconds:
{
Description: The leg travel time, in seconds, to travel between the first and last point of this leg. ,
Format: int64 ,
Required: False ,
}
integer ,
startLevel:
{
Description: The floor where this leg starts. ,
Format: int32 ,
Required: False ,
}
integer ,
endLevel:
{
Description: The floor where this leg ends. ,
Format: int32 ,
Required: False ,
}
integer ,
points:
{
Description: The leg shape points. Their vertical position is determined as follows: all the points are at the same height when startLevel and endLevel are the same, otherwise the array will contain only two points: the first at startLevel and the second at endLevel. ,
Required: False ,
}
[
{
latitude:
{
Description: the point latitude ,
Required: True ,
}
number ,
longitude:
{
Description: the point longitude ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}