Skip to content

Commit 946b946

Browse files
author
Jill Grant
authored
Merge pull request #265484 from stevemunk/rest-toc
Updating references to the Azure Maps and Creator REST API docs
2 parents 925a95f + 6e0df8b commit 946b946

File tree

3 files changed

+147
-70
lines changed

3 files changed

+147
-70
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Links to the Azure Maps Rest API
3+
titleSuffix: Microsoft Azure Maps
4+
description: Links to the Azure Maps Rest API.
5+
author: eriklindeman
6+
ms.author: eriklind
7+
ms.date: 02/05/2024
8+
ms.topic: reference
9+
ms.service: azure-maps
10+
services: azure-maps
11+
---
12+
13+
# Azure Maps Rest API
14+
15+
Azure Maps is a set of mapping and geospatial services that enable developers and organizations to build intelligent location-based experiences for applications across many different industries and use cases. Use Azure Maps to bring maps, geocoding, location search, routing, real-time traffic, geolocation, time zone information and weather data into your web, mobile and server-side solutions.
16+
17+
The following tables show overviews of the services that Azure Maps offers:
18+
19+
## Latest release
20+
21+
The most recent stable release of the Azure Maps services.
22+
23+
| API | Description |
24+
|-----|-------------|
25+
| [Data] | The Azure Maps Data v2 service is deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service need to be updated to use the Azure Maps [Data registry] service by 9/16/24. For more information, see [How to create data registry]. |
26+
| [Data Registry] | Programmatically store and update geospatial data to use in spatial operations. |
27+
| [Geolocation] | Convert IP addresses to country/region ISO codes. |
28+
| [Render] | Get road, satellite/aerial, weather, traffic map tiles, and static map images. |
29+
| [Route] | Calculate optimized travel times and distances between locations for multiple modes of transportation and get localized travel instructions. |
30+
| [Search] | Geocode addresses and coordinates, search for business listings and places by name or category and get administrative boundary polygons. |
31+
| [Spatial] | Use geofences, great circle distances and other spatial operations to analyze location data. |
32+
| [Timezone] | Get time zone and sunrise/sunset information for specified locations. |
33+
| [Traffic] | Get current traffic information including traffic flow and traffic incident details. |
34+
| [Weather] | Get current, forecasted, and historical weather conditions, air quality, tropical storm details and weather along a route. |
35+
36+
## Previous release
37+
38+
A previous stable release of an Azure Maps service that is still in use. The services in this list will generally have a more recent version available, and are slated for retirement. If using a previous release, update to the latest version before it's retired to avoid disruption of service.
39+
40+
| API | Description |
41+
|-----|-------------|
42+
| [Data][Data-v1] | The Azure Maps Data v1 service is deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service need to be updated to use the Azure Maps [Data registry] service by 9/16/24. For more information, see [How to create data registry]. |
43+
| [Render][Render v1] | Get road, satellite/aerial, weather, traffic map tiles and static map images.<BR>The Azure Maps [Render v1] service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API needs to be updated to use the latest version of the [Render] API by 9/17/26. |
44+
| [Search][Search-v1] | Geocode addresses and coordinates, search for business listings and places by name or category and get administrative boundary polygons. This is version 1.0 of the Search service. For the latest version, see [Search]. |
45+
46+
## Latest preview
47+
48+
Prerelease version of an Azure Maps service. Preview releases contain new functionality or updates to existing functionality that will be included in a future release.
49+
50+
| API | Description |
51+
|-----|-------------|
52+
| [Route][Route-2023-10-01-preview] | Returns the ideal route in GeoJSON between locations for multiple modes of transportation.<BR><BR>Some of the updates in this version of the Route service include:<ul><li>Routes with "via" waypoints that the route must pass through.</li><li>More geographies</li><li>More languages available for localized travel instructions.</li></ul> |
53+
54+
<!--- Links to latest versions of each service ---------------------------------->
55+
[Data]: /rest/api/maps/data
56+
[How to create data registry]: /azure/azure-maps/how-to-create-data-registries
57+
[Data Registry]: /rest/api/maps/data-registry
58+
[Geolocation]: /rest/api/maps/geolocation
59+
[Render]: /rest/api/maps/render
60+
[Route]: /rest/api/maps/route
61+
[Search]: /rest/api/maps/search
62+
[Spatial]: /rest/api/maps/spatial
63+
[Timezone]: /rest/api/maps/timezone
64+
[Traffic]: /rest/api/maps/traffic
65+
[Weather]: /rest/api/maps/weather
66+
67+
<!--- Links to previous versions of each service -------------------------------->
68+
[Data-v1]: /rest/api/maps/data?view=rest-maps-1.0
69+
[Render v1]: /rest/api/maps/render?view=rest-maps-1.0
70+
[Search-v1]: /rest/api/maps/search?view=rest-maps-1.0
71+
72+
<!--- 2023-10-01-preview is the latest preview release of the Route service,
73+
currently the only Azure Maps service in Preview -------------------------->
74+
[Route-2023-10-01-preview]: /rest/api/maps/route?view=rest-maps-2023-10-01-preview
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Links to the Azure Maps Creator Rest API
3+
titleSuffix: Microsoft Azure Maps Creator
4+
description: Links to the Azure Maps Creator Rest API
5+
author: eriklindeman
6+
ms.author: eriklind
7+
ms.date: 02/05/2024
8+
ms.topic: reference
9+
ms.service: azure-maps
10+
services: azure-maps
11+
---
12+
13+
# Creator Rest API
14+
15+
Indoor mapping is a technology that enables the creation of digital maps of the interior of buildings. It helps visitors navigate through buildings and locate points of interest such as restrooms, conference rooms, and offices. Indoor mapping can be used to create a more convenient and enjoyable visitor experience. Visitors can spend less time searching for building directories and more time discovering new points of interest. With Azure Maps Creator, you can create indoor maps that enable customers to zoom in and out of a building to see each floor and navigate to any desired location using Creator's wayfinding service. In addition to common mapping functionality, Azure Maps Creator offers an array of useful services that enable you to implement functionality such as asset tracking, facility management, workspace optimization, hybrid work models to support a blend of in-office, remote, and on-the-go working, and much more.
16+
17+
The following tables offer high-level overviews of the services that Azure Maps Creator offers:
18+
19+
## Latest release
20+
21+
The most recent stable release of the Creator services.
22+
23+
| API | Description |
24+
|-----|-------------|
25+
| [Alias] | This API allows the caller to assign an alias to reference a resource. |
26+
| [Conversion] | Used to import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps.|
27+
| [Dataset] | A collection containing the indoor map [features](/azure/azure-maps/glossary#feature) of a facility. This API allows the caller to create a dataset from previously uploaded data. |
28+
| [Feature State] | The Feature stateset can be used to dynamically render features in a facility according to their current state and respective map style. |
29+
| [Tileset] |`tileset` is a collection of vector tiles that render on the map, created from an existing dataset. |
30+
| [WFS] | Use the Web Feature Service (WFS) API to query for all feature collections or a specific collection within a dataset. For example, you can use WFS to find all mid-size meeting rooms in a specific building and floor level. |
31+
32+
## Latest preview
33+
34+
Pre-release version of a Creator service. Preview releases contain new functionality or updates to existing functionality that will be included in a future release.
35+
36+
| API | Description |
37+
|-----|-------------|
38+
| [Alias][Alias-preview] | This API allows the caller to assign an alias to reference a resource. |
39+
| [Conversion][Conversion-preview] | Used to import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps.|
40+
| [Dataset][Dataset-preview] | A collection of indoor map [features](/azure/azure-maps/glossary#feature) in a facility. This API allows the caller to create a dataset from previously uploaded data. |
41+
| [Feature State][Feature State-preview] | The Feature stateset can be used to dynamically render features in a facility according to their current state and respective map style. |
42+
| [Features] | An instance of an object produced from the [Conversion][Conversion-preview] service that combines a geometry with metadata information. |
43+
| [Map Configuration] | Map Configuration in indoor mapping refers to the default settings of a map that are applied when the map is loaded. It includes the default zoom level, center point, and other map settings. |
44+
| [Routeset] | Use the routeset API to create the data that the wayfinding service needs to generate paths. |
45+
| [Style] | Use the Style API to customize your facility's look and feel. Everything is configurable from the color of a feature, the icon that renders, or the zoom level when a feature should appear or disappear. |
46+
| [Tileset][Tileset-preview] | A collection of vector tiles that render on the map, created from an existing dataset. |
47+
| [Wayfinding] | Wayfinding is a technology that helps people navigate through complex indoor environments such as malls, offices, stadiums, airports and office buildings. |
48+
49+
<!--- V2 is the latest stable release of each Creator service --->
50+
51+
[Alias]: /rest/api/maps-creator/alias
52+
[Conversion]: /rest/api/maps-creator/conversion
53+
[Dataset]: /rest/api/maps-creator/dataset
54+
[Feature State]: /rest/api/maps-creator/feature-state
55+
[Tileset]: /rest/api/maps-creator/tileset
56+
[WFS]: /rest/api/maps-creator/wfs
57+
58+
<!--- 2023-03-01-preview is the latest preview release of each Creator service ---->
59+
60+
[Alias-preview]: /rest/api/maps-creator/alias?view=rest-maps-creator-2023-03-01-preview
61+
[Conversion-preview]: /rest/api/maps-creator/conversion?view=rest-maps-creator-2023-03-01-preview
62+
[Dataset-preview]: /rest/api/maps-creator/dataset?view=rest-maps-creator-2023-03-01-preview
63+
[Feature State-preview]: /rest/api/maps-creator/feature-state?view=rest-maps-creator-2023-03-01-preview
64+
[Features]: /rest/api/maps-creator/features?view=rest-maps-creator-2023-03-01-preview
65+
[Map configuration]: /rest/api/maps-creator/map-configuration?view=rest-maps-creator-2023-03-01-preview
66+
[Routeset]: /rest/api/maps-creator/routeset?view=rest-maps-creator-2023-03-01-preview
67+
[Style]: /rest/api/maps-creator/style?view=rest-maps-creator-2023-03-01-preview
68+
[Tileset-preview]: /rest/api/maps-creator/tileset?view=rest-maps-creator-2023-03-01-preview
69+
[Wayfinding]: /rest/api/maps-creator/wayfinding?view=rest-maps-creator-2023-03-01-preview

articles/azure-maps/toc.yml

Lines changed: 4 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -421,76 +421,10 @@ items:
421421
href: supported-search-categories.md
422422
- name: REST
423423
items:
424-
- name: Overview
425-
href: /rest/api/maps
426-
- name: Data
427-
href: /rest/api/maps/data?view=rest-maps-1.0&preserve-view=true
428-
- name: Data V2
429-
href: /rest/api/maps/data
430-
- name: Data Registry
431-
href: /rest/api/maps/data-registry
432-
- name: Geolocation
433-
href: /rest/api/maps/geolocation
434-
- name: Render
435-
href: /rest/api/maps/render?view=rest-maps-1.0&preserve-view=true
436-
- name: Render V2
437-
href: /rest/api/maps/render
438-
- name: Route
439-
href: /rest/api/maps/route
440-
- name: Route V2 (Preview)
441-
href: /rest/api/maps/route?view=rest-maps-2023-10-01-preview&preserve-view=true
442-
- name: Search
443-
href: /rest/api/maps/search?view=rest-maps-1.0&preserve-view=true
444-
- name: Search V2
445-
href: /rest/api/maps/search
446-
- name: Spatial
447-
href: /rest/api/maps/spatial
448-
- name: Timezone
449-
href: /rest/api/maps/timezone
450-
- name: Traffic
451-
href: /rest/api/maps/traffic
452-
- name: Weather
453-
href: /rest/api/maps/weather
454-
- name: Maps Creator
455-
items:
456-
- name: Overview
457-
href: /rest/api/maps-creator/
458-
- name: 2023-03-01-preview
459-
items:
460-
- name: Alias
461-
href: /rest/api/maps-creator/alias?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
462-
- name: Conversion
463-
href: /rest/api/maps-creator/conversion?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
464-
- name: Dataset
465-
href: /rest/api/maps-creator/dataset?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
466-
- name: Feature State
467-
href: /rest/api/maps-creator/feature-state?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
468-
- name: Features
469-
href: /rest/api/maps-creator/features?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
470-
- name: Map configuration
471-
href: /rest/api/maps-creator/map-configuration?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
472-
- name: Routeset
473-
href: /rest/api/maps-creator/routeset?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
474-
- name: Style
475-
href: /rest/api/maps-creator/style?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
476-
- name: Tileset
477-
href: /rest/api/maps-creator/tileset?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
478-
- name: Wayfinding
479-
href: /rest/api/maps-creator/wayfinding?view=rest-maps-creator-2023-03-01-preview&preserve-view=true
480-
- name: V2
481-
items:
482-
- name: Alias
483-
href: /rest/api/maps-creator/alias
484-
- name: Conversion
485-
href: /rest/api/maps-creator/conversion
486-
- name: Dataset
487-
href: /rest/api/maps-creator/dataset
488-
- name: Feature State
489-
href: /rest/api/maps-creator/feature-state
490-
- name: Tileset
491-
href: /rest/api/maps-creator/tileset
492-
- name: WFS
493-
href: /rest/api/maps-creator/wfs
424+
- name: Maps REST API
425+
href: rest-api-azure-maps.md
426+
- name: Maps Creator REST API
427+
href: rest-api-creator.md
494428
- name: Maps account management
495429
href: /rest/api/maps-management/
496430
- name: JavaScript

0 commit comments

Comments
 (0)