Skip to content

Commit 368766b

Browse files
stevemunkstevemunk
committed
Updating references to the REST API docset
1 parent 65c99ad commit 368766b

File tree

3 files changed

+137
-70
lines changed

3 files changed

+137
-70
lines changed

‎articles/azure-maps/rest-api-azure-maps.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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+
# 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 released versions
20+
21+
| API | Description |
22+
|-----|-------------|
23+
| [Data] | The Azure Maps Data v2 service has been deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will 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]. |
24+
| [Data Registry] | Programmatically store and update geospatial data to use in spatial operations. |
25+
| [Geolocation] | Convert IP addresses to country/region ISO codes. |
26+
| [Render] | Get road, satellite/aerial, weather, traffic map tiles and static map images. |
27+
| [Route] | Calculate optimized travel times and distances between locations for multiple modes of transportation and get localized travel instructions. |
28+
| [Search] | Geocode addresses and coordinates, search for business listings and places by name or category and get administrative boundary polygons. |
29+
| [Spatial] | Use geofences, great circle distances and other spatial operations to analyze location data. |
30+
| [Timezone] | Get time zone and sunrise/sunset information for specified locations. |
31+
| [Traffic] | Get current traffic information including traffic flow and traffic incident details. |
32+
| [Weather] | Get current, forecasted and historical weather conditions, air quality, tropical storm details and weather along a route. |
33+
34+
## Previous release versions
35+
36+
| API | Description |
37+
|-----|-------------|
38+
| [Data][Data-v1] | The Azure Maps Data v1 service has been deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will 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]. |
39+
| [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 will need to be updated to use the latest version of the [Render] API by 9/17/26. |
40+
| [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]. |
41+
42+
## Latest preview version
43+
44+
| API | Description |
45+
|-----|-------------|
46+
| [Route][Route-2023-10-01-preview] | Calculate optimized travel times and distances between locations for multiple modes of transportation and get localized travel instructions. |
47+
48+
<!--- Links to latest versions of each service ---------------------------------->
49+
[Data]: /rest/api/maps/data
50+
[How to create data registry]: /azure/azure-maps/how-to-create-data-registries
51+
[Data Registry]: /rest/api/maps/data-registry
52+
[Geolocation]: /rest/api/maps/geolocation
53+
[Render]: /rest/api/maps/render
54+
[Route]: /rest/api/maps/route
55+
[Search]: /rest/api/maps/search
56+
[Spatial]: /rest/api/maps/spatial
57+
[Timezone]: /rest/api/maps/timezone
58+
[Traffic]: /rest/api/maps/traffic
59+
[Weather]: /rest/api/maps/weather
60+
61+
<!--- Links to previous versions of each service -------------------------------->
62+
[Data-v1]: /rest/api/maps/data?view=rest-maps-1.0
63+
[Render v1]: /rest/api/maps/render?view=rest-maps-1.0
64+
[Search-v1]: /rest/api/maps/search?view=rest-maps-1.0
65+
66+
<!--- 2023-10-01-preview is the latest preview release of the Route service,
67+
currently the only Azure Maps service in Preview -------------------------->
68+
[Route-2023-10-01-preview]: /rest/api/maps/route?view=rest-maps-2023-10-01-preview

‎articles/azure-maps/rest-api-creator.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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+
# 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 released version
20+
21+
| API | Description |
22+
|-----|-------------|
23+
| [Alias] | This API allows the caller to assign an alias to reference a resource. |
24+
| [Conversion] | Used to import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps.|
25+
| [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. |
26+
| [Feature State] | The Feature stateset can be used to dynamically render features in a facility according to their current state and respective map style. |
27+
| [Tileset] | A `tileset` is a collection of vector tiles that render on the map, created from an existing dataset. |
28+
| [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. |
29+
30+
## Latest preview version
31+
32+
| API | Description |
33+
|-----|-------------|
34+
| [Alias][Alias-preview] | This API allows the caller to assign an alias to reference a resource. |
35+
| [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.|
36+
| [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. |
37+
| [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. |
38+
| [Features] | An instance of an object produced from the [Conversion][Conversion-preview] service that combines a geometry with metadata information. |
39+
| [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. |
40+
| [Routeset] | Use the routeset API to create the data that the wayfinding service needs to generate paths. |
41+
| [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. |
42+
| [Tileset][Tileset-preview] | A collection of vector tiles that render on the map, created from an existing dataset. |
43+
| [Wayfinding] | Wayfinding is a technology that helps people navigate through complex indoor environments such as malls, offices, stadiums, airports and office buildings. |
44+
45+
<!--- V2 is the latest stable release of each Creator service --->
46+
47+
[Alias]: /rest/api/maps-creator/alias
48+
[Conversion]: /rest/api/maps-creator/conversion
49+
[Dataset]: /rest/api/maps-creator/dataset
50+
[Feature State]: /rest/api/maps-creator/feature-state
51+
[Tileset]: /rest/api/maps-creator/tileset
52+
[WFS]: /rest/api/maps-creator/wfs
53+
54+
<!--- 2023-03-01-preview is the latest preview release of each Creator service ---->
55+
56+
[Alias-preview]: /rest/api/maps-creator/alias?view=rest-maps-creator-2023-03-01-preview
57+
[Conversion-preview]: /rest/api/maps-creator/conversion?view=rest-maps-creator-2023-03-01-preview
58+
[Dataset-preview]: /rest/api/maps-creator/dataset?view=rest-maps-creator-2023-03-01-preview
59+
[Feature State-preview]: /rest/api/maps-creator/feature-state?view=rest-maps-creator-2023-03-01-preview
60+
[Features]: /rest/api/maps-creator/features?view=rest-maps-creator-2023-03-01-preview
61+
[Map configuration]: /rest/api/maps-creator/map-configuration?view=rest-maps-creator-2023-03-01-preview
62+
[Routeset]: /rest/api/maps-creator/routeset?view=rest-maps-creator-2023-03-01-preview
63+
[Style]: /rest/api/maps-creator/style?view=rest-maps-creator-2023-03-01-preview
64+
[Tileset-preview]: /rest/api/maps-creator/tileset?view=rest-maps-creator-2023-03-01-preview
65+
[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
@@ -419,76 +419,10 @@ items:
419419
href: supported-search-categories.md
420420
- name: REST
421421
items:
422-
- name: Overview
423-
href: /rest/api/maps
424-
- name: Data
425-
href: /rest/api/maps/data?view=rest-maps-1.0
426-
- name: Data V2
427-
href: /rest/api/maps/data
428-
- name: Data Registry
429-
href: /rest/api/maps/data-registry
430-
- name: Geolocation
431-
href: /rest/api/maps/geolocation
432-
- name: Render
433-
href: /rest/api/maps/render?view=rest-maps-1.0
434-
- name: Render V2
435-
href: /rest/api/maps/render
436-
- name: Route
437-
href: /rest/api/maps/route
438-
- name: Route V2 (Preview)
439-
href: /rest/api/maps/route?view=rest-maps-2023-10-01-preview
440-
- name: Search
441-
href: /rest/api/maps/search?view=rest-maps-1.0
442-
- name: Search V2
443-
href: /rest/api/maps/search
444-
- name: Spatial
445-
href: /rest/api/maps/spatial
446-
- name: Timezone
447-
href: /rest/api/maps/timezone
448-
- name: Traffic
449-
href: /rest/api/maps/traffic
450-
- name: Weather
451-
href: /rest/api/maps/weather
452-
- name: Maps Creator
453-
items:
454-
- name: Overview
455-
href: /rest/api/maps-creator/
456-
- name: 2023-03-01-preview
457-
items:
458-
- name: Alias
459-
href: /rest/api/maps-creator/alias?view=rest-maps-creator-2023-03-01-preview
460-
- name: Conversion
461-
href: /rest/api/maps-creator/conversion?view=rest-maps-creator-2023-03-01-preview
462-
- name: Dataset
463-
href: /rest/api/maps-creator/dataset?view=rest-maps-creator-2023-03-01-preview
464-
- name: Feature State
465-
href: /rest/api/maps-creator/feature-state?view=rest-maps-creator-2023-03-01-preview
466-
- name: Features
467-
href: /rest/api/maps-creator/features?view=rest-maps-creator-2023-03-01-preview
468-
- name: Map configuration
469-
href: /rest/api/maps-creator/map-configuration?view=rest-maps-creator-2023-03-01-preview
470-
- name: Routeset
471-
href: /rest/api/maps-creator/routeset?view=rest-maps-creator-2023-03-01-preview
472-
- name: Style
473-
href: /rest/api/maps-creator/style?view=rest-maps-creator-2023-03-01-preview
474-
- name: Tileset
475-
href: /rest/api/maps-creator/tileset?view=rest-maps-creator-2023-03-01-preview
476-
- name: Wayfinding
477-
href: /rest/api/maps-creator/wayfinding?view=rest-maps-creator-2023-03-01-preview
478-
- name: V2
479-
items:
480-
- name: Alias
481-
href: /rest/api/maps-creator/alias
482-
- name: Conversion
483-
href: /rest/api/maps-creator/conversion
484-
- name: Dataset
485-
href: /rest/api/maps-creator/dataset
486-
- name: Feature State
487-
href: /rest/api/maps-creator/feature-state
488-
- name: Tileset
489-
href: /rest/api/maps-creator/tileset
490-
- name: WFS
491-
href: /rest/api/maps-creator/wfs
422+
- name: Azure Maps REST API
423+
href: rest-api-maps.md
424+
- name: Azure Maps Creator REST API
425+
href: rest-api-creator.md
492426
- name: Maps account management
493427
href: /rest/api/maps-management/
494428
- name: JavaScript

0 commit comments

Comments
 (0)