From 8f1a292d9fb39d3de18667a76b98966d6dd9a483 Mon Sep 17 00:00:00 2001
From: steve munk <33468793+stevemunk@users.noreply.github.com>
Date: Mon, 20 Nov 2023 10:11:10 -0800
Subject: [PATCH 1/2] Update readme.md: Common/stable/2023-06-01
current: Common/stable/2023-07-01
Updated: Common/stable/2023-06-01
---
specification/maps/data-plane/readme.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/maps/data-plane/readme.md b/specification/maps/data-plane/readme.md
index fe2b8aa34b34..b6e5e96a733f 100644
--- a/specification/maps/data-plane/readme.md
+++ b/specification/maps/data-plane/readme.md
@@ -51,7 +51,7 @@ These settings apply only when `--tag=package-stable-2023-07-01` is specified on
```yaml $(tag) == 'package-stable-2023-07-01'
input-file:
- - Common/stable/2023-07-01/common.json
+ - Common/stable/2023-06-01/common.json
- Creator/stable/2023-07-01/alias.json
- Creator/stable/2023-07-01/dataset.json
- Creator/stable/2023-07-01/dwgconversion.json
From e658d09acff34bb94d4ffcc35d9ca398eb024528 Mon Sep 17 00:00:00 2001
From: stevemunk <33468793+stevemunk@users.noreply.github.com>
Date: Thu, 28 Dec 2023 13:12:08 -0800
Subject: [PATCH 2/2] Removing spatial from the Creator swagger files. It is
not used and does not belong there.
---
.../Spatial_EvaluatePointInPolygon.json | 31 -
.../examples/spatial/Spatial_GetBuffer.json | 170 ----
.../spatial/Spatial_GetClosestPoint.json | 34 -
.../examples/spatial/Spatial_GetGeofence.json | 47 -
.../Spatial_GetGreatCircleDistance.json | 27 -
.../examples/spatial/Spatial_PostBuffer.json | 191 ----
.../spatial/Spatial_PostClosestPoint.json | 77 --
.../spatial/Spatial_PostGeofence.json | 133 ---
.../spatial/Spatial_PostPointInPolygon.json | 63 --
.../Creator/preview/1.0/spatial.json | 902 ------------------
10 files changed, 1675 deletions(-)
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json
delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/spatial.json
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json
deleted file mode 100644
index 5d94dd13c8c0..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json
+++ /dev/null
@@ -1,31 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "udid": "[udid]",
- "lat": 47.622942,
- "lon": -122.316456
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "sourcePoint": {
- "lat": 33.5362475,
- "lon": -111.9267386
- },
- "udid": "[udid from request]",
- "information": "4 polygons processed in user data"
- },
- "result": {
- "pointInPolygons": true,
- "intersectingGeometries": [
- "1001",
- "1003"
- ]
- }
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json
deleted file mode 100644
index f0cdf649b353..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json
+++ /dev/null
@@ -1,170 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "udid": "[udid]",
- "distances": "176.3"
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "udid": "[udid from request]",
- "information": "1 feature processed in user data"
- },
- "result": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "geometryId": "ExampleId",
- "bufferDist": 176.3
- },
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -111.92483859605078,
- 33.5362475
- ],
- [
- -111.92487510409389,
- 33.53587682761772
- ],
- [
- -111.92498322523961,
- 33.535520399967204
- ],
- [
- -111.92515880445296,
- 33.535191914363196
- ],
- [
- -111.92539509432322,
- 33.53490399432323
- ],
- [
- -111.92568301436319,
- 33.534667704452971
- ],
- [
- -111.9260114999672,
- 33.53449212523963
- ],
- [
- -111.9263679276177,
- 33.5343840040939
- ],
- [
- -111.9267386,
- 33.534347496050785
- ],
- [
- -111.92710927238228,
- 33.5343840040939
- ],
- [
- -111.92746570003278,
- 33.53449212523963
- ],
- [
- -111.9277941856368,
- 33.534667704452971
- ],
- [
- -111.92808210567676,
- 33.53490399432323
- ],
- [
- -111.92831839554702,
- 33.535191914363196
- ],
- [
- -111.92849397476037,
- 33.535520399967204
- ],
- [
- -111.9286020959061,
- 33.53587682761772
- ],
- [
- -111.92863860394921,
- 33.5362475
- ],
- [
- -111.9286020959061,
- 33.536618172382283
- ],
- [
- -111.92849397476037,
- 33.5369746000328
- ],
- [
- -111.92831839554702,
- 33.537303085636808
- ],
- [
- -111.92808210567676,
- 33.537591005676774
- ],
- [
- -111.9277941856368,
- 33.537827295547032
- ],
- [
- -111.92746570003278,
- 33.538002874760373
- ],
- [
- -111.92710927238228,
- 33.5381109959061
- ],
- [
- -111.9267386,
- 33.538147503949219
- ],
- [
- -111.9263679276177,
- 33.5381109959061
- ],
- [
- -111.9260114999672,
- 33.538002874760373
- ],
- [
- -111.92568301436319,
- 33.537827295547032
- ],
- [
- -111.92539509432322,
- 33.537591005676774
- ],
- [
- -111.92515880445296,
- 33.537303085636808
- ],
- [
- -111.92498322523961,
- 33.5369746000328
- ],
- [
- -111.92487510409389,
- 33.536618172382283
- ],
- [
- -111.92483859605078,
- 33.5362475
- ]
- ]
- ]
- }
- }
- ]
- }
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json
deleted file mode 100644
index 426ebeaf3725..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json
+++ /dev/null
@@ -1,34 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "udid": "[udid]",
- "lat": 47.622942,
- "lon": -122.316456
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "sourcePoint": {
- "lat": 47.622942,
- "lon": -122.316456
- },
- "udid": "[udid from request]",
- "information": "10 points processed in user data"
- },
- "result": [
- {
- "distanceInMeters": 1587492.66,
- "position": {
- "lat": 40.516153406773952,
- "lon": -105.02860293715861
- },
- "geometryId": "1001"
- }
- ]
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json
deleted file mode 100644
index 774de28742a6..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json
+++ /dev/null
@@ -1,47 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "deviceId": "unique_device_name_under_account",
- "udid": "[udId]",
- "lat": 48.36,
- "lon": -124.63,
- "searchBuffer": 50,
- "userTime": "2017-07-21T17:32:28Z",
- "isAsync": true,
- "mode": "EnterAndExit"
- },
- "responses": {
- "200": {
- "body": {
- "geometries": [
- {
- "deviceId": "unique_device_name_under_account",
- "udId": "[udId]",
- "geometryId": "2",
- "distance": 999,
- "nearestLat": 47.621954,
- "nearestLon": -122.131841
- },
- {
- "deviceId": "unique_device_name_under_account",
- "udId": "[udId]",
- "geometryId": "1",
- "distance": -999,
- "nearestLat": 47.609833,
- "nearestLon": -122.148274
- }
- ],
- "expiredGeofenceGeometryId": [
- "5"
- ],
- "invalidPeriodGeofenceGeometryId": [
- "3",
- "4"
- ],
- "isEventPublished": true
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json
deleted file mode 100644
index 0565252283f3..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json
+++ /dev/null
@@ -1,27 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "query": "47.622942,-122.316456:47.610378,-122.200676"
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "sourcePoint": {
- "lat": 47.622942,
- "lon": -122.316456
- },
- "targetPoint": {
- "lat": 47.610378,
- "lon": -122.200676
- }
- },
- "result": {
- "distanceInMeters": 8797.62
- }
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json
deleted file mode 100644
index 201618ac2347..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json
+++ /dev/null
@@ -1,191 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "bufferRequestBody": {
- "geometries": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "geometryId": "ExampleId"
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -111.9267386,
- 33.5362475
- ]
- }
- }
- ]
- },
- "distances": [
- 176.3
- ]
- }
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "udid": null,
- "information": "1 feature processed in user data"
- },
- "result": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "geometryId": "ExampleId",
- "bufferDist": 176.3
- },
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -111.92483859605078,
- 33.5362475
- ],
- [
- -111.92487510409389,
- 33.53587682761772
- ],
- [
- -111.92498322523961,
- 33.535520399967204
- ],
- [
- -111.92515880445296,
- 33.535191914363196
- ],
- [
- -111.92539509432322,
- 33.53490399432323
- ],
- [
- -111.92568301436319,
- 33.534667704452971
- ],
- [
- -111.9260114999672,
- 33.53449212523963
- ],
- [
- -111.9263679276177,
- 33.5343840040939
- ],
- [
- -111.9267386,
- 33.534347496050785
- ],
- [
- -111.92710927238228,
- 33.5343840040939
- ],
- [
- -111.92746570003278,
- 33.53449212523963
- ],
- [
- -111.9277941856368,
- 33.534667704452971
- ],
- [
- -111.92808210567676,
- 33.53490399432323
- ],
- [
- -111.92831839554702,
- 33.535191914363196
- ],
- [
- -111.92849397476037,
- 33.535520399967204
- ],
- [
- -111.9286020959061,
- 33.53587682761772
- ],
- [
- -111.92863860394921,
- 33.5362475
- ],
- [
- -111.9286020959061,
- 33.536618172382283
- ],
- [
- -111.92849397476037,
- 33.5369746000328
- ],
- [
- -111.92831839554702,
- 33.537303085636808
- ],
- [
- -111.92808210567676,
- 33.537591005676774
- ],
- [
- -111.9277941856368,
- 33.537827295547032
- ],
- [
- -111.92746570003278,
- 33.538002874760373
- ],
- [
- -111.92710927238228,
- 33.5381109959061
- ],
- [
- -111.9267386,
- 33.538147503949219
- ],
- [
- -111.9263679276177,
- 33.5381109959061
- ],
- [
- -111.9260114999672,
- 33.538002874760373
- ],
- [
- -111.92568301436319,
- 33.537827295547032
- ],
- [
- -111.92539509432322,
- 33.537591005676774
- ],
- [
- -111.92515880445296,
- 33.537303085636808
- ],
- [
- -111.92498322523961,
- 33.5369746000328
- ],
- [
- -111.92487510409389,
- 33.536618172382283
- ],
- [
- -111.92483859605078,
- 33.5362475
- ]
- ]
- ]
- }
- }
- ]
- }
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json
deleted file mode 100644
index c47be26bac17..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json
+++ /dev/null
@@ -1,77 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "lat": 47.622942,
- "lon": -122.316456,
- "closestPointRequestBody": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "geometryId": 1001
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -105.02860293715861,
- 40.516153406773952
- ]
- }
- },
- {
- "type": "Feature",
- "properties": {
- "geometryId": 1002
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -105.02860381672178,
- 40.515990990037309
- ]
- }
- },
- {
- "type": "Feature",
- "properties": {
- "geometryId": 1003
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -105.02812292879467,
- 40.516058678088562
- ]
- }
- }
- ]
- }
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "sourcePoint": {
- "lat": 47.622942,
- "lon": -122.316456
- },
- "udid": null,
- "information": "3 points processed in user data"
- },
- "result": [
- {
- "distanceInMeters": 1587492.66,
- "position": {
- "lat": 40.516153406773952,
- "lon": -105.02860293715861
- },
- "geometryId": "1001"
- }
- ]
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json
deleted file mode 100644
index 11c4fe5176c7..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json
+++ /dev/null
@@ -1,133 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "deviceId": "unique_device_name_under_account",
- "lat": 48.36,
- "lon": -124.63,
- "searchBuffer": 50,
- "usertime": "2017-07-21T17:32:28Z",
- "isAsync": true,
- "mode": "EnterAndExit",
- "searchGeofenceRequestBody": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -122.13241226662022,
- 47.61701140091722
- ],
- [
- -122.12810106940353,
- 47.6169969269402
- ],
- [
- -122.12824948956276,
- 47.61907683751349
- ],
- [
- -122.12833297981392,
- 47.621929787055336
- ],
- [
- -122.12971398040168,
- 47.62184100705295
- ],
- [
- -122.1318413862121,
- 47.62195364373008
- ],
- [
- -122.13231034769727,
- 47.61716332618121
- ],
- [
- -122.13241226662022,
- 47.61701140091722
- ]
- ]
- ]
- },
- "properties": {
- "geometryId": "2",
- "name": "Crossroad Mall"
- }
- },
- {
- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -122.1534220563239,
- 47.60981818546625
- ],
- [
- -122.153451623509,
- 47.60628733146004
- ],
- [
- -122.14971782206638,
- 47.606250040787046
- ],
- [
- -122.14817354810637,
- 47.606391046012305
- ],
- [
- -122.1482735128807,
- 47.60983316796356
- ],
- [
- -122.15225500989803,
- 47.60982613678752
- ],
- [
- -122.1534220563239,
- 47.60981818546625
- ]
- ]
- ]
- },
- "properties": {
- "geometryId": "1",
- "name": "Sammamish High school"
- }
- }
- ]
- }
- },
- "responses": {
- "200": {
- "headers": {},
- "body": {
- "geometries": [
- {
- "deviceId": "unique_device_name_under_account",
- "geometryId": "2",
- "distance": -999,
- "nearestLat": 47.621954,
- "nearestLon": -122.131841
- },
- {
- "deviceId": "unique_device_name_under_account",
- "geometryId": "1",
- "distance": 999,
- "nearestLat": 47.609833,
- "nearestLon": -122.148274
- }
- ],
- "expiredGeofenceGeometryId": [],
- "invalidPeriodGeofenceGeometryId": [],
- "isEventPublished": true
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json
deleted file mode 100644
index fc0ce0e8d71e..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json
+++ /dev/null
@@ -1,63 +0,0 @@
-{
- "parameters": {
- "geography": "us",
- "format": "json",
- "api-version": "1.0",
- "lat": 33.5362475,
- "lon": -111.9267386,
- "pointInPolygonRequestBody": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "geometryId": 1001
- },
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -111.9267386,
- 33.5362475
- ],
- [
- -111.9627875,
- 33.5104882
- ],
- [
- -111.9027061,
- 33.5004686
- ],
- [
- -111.9267386,
- 33.5362475
- ]
- ]
- ]
- }
- }
- ]
- }
- },
- "responses": {
- "200": {
- "body": {
- "summary": {
- "sourcePoint": {
- "lat": 33.5362475,
- "lon": -111.9267386
- },
- "udid": null,
- "information": "1 polygons processed in user data"
- },
- "result": {
- "pointInPolygons": true,
- "intersectingGeometries": [
- "1001"
- ]
- }
- }
- }
- }
-}
diff --git a/specification/maps/data-plane/Creator/preview/1.0/spatial.json b/specification/maps/data-plane/Creator/preview/1.0/spatial.json
deleted file mode 100644
index 255bb0aebe37..000000000000
--- a/specification/maps/data-plane/Creator/preview/1.0/spatial.json
+++ /dev/null
@@ -1,902 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "title": "Azure Maps Spatial Service",
- "version": "1.0",
- "description": "Azure Maps Spatial REST APIs"
- },
- "x-ms-parameterized-host": {
- "hostTemplate": "{geography}.atlas.microsoft.com",
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation"
- }
- ]
- },
- "schemes": [
- "https"
- ],
- "consumes": [],
- "produces": [
- "application/json"
- ],
- "securityDefinitions": {
- "AADToken": {
- "type": "oauth2",
- "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
- "flow": "implicit",
- "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).",
- "scopes": {
- "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
- }
- },
- "SharedKey": {
- "type": "apiKey",
- "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
- "name": "subscription-key",
- "in": "query"
- },
- "SasToken": {
- "type": "apiKey",
- "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.",
- "name": "SAS Token",
- "in": "header"
- }
- },
- "security": [
- {
- "AADToken": [
- "https://atlas.microsoft.com/.default"
- ]
- },
- {
- "SharedKey": []
- },
- {
- "SasToken": []
- }
- ],
- "responses": {},
- "parameters": {
- "ApiVersion": {
- "name": "api-version",
- "description": "Version number of Azure Maps API.",
- "type": "string",
- "in": "query",
- "required": true,
- "default": "1.0",
- "x-ms-parameter-location": "client"
- },
- "GeofenceMode": {
- "name": "mode",
- "in": "query",
- "description": "Mode of the geofencing async event mechanism.",
- "type": "string",
- "enum": [
- "All",
- "EnterAndExit"
- ],
- "x-ms-enum": {
- "name": "GeofenceMode",
- "modelAsString": true,
- "values": [
- {
- "value": "All",
- "description": "Publish all the query results to Azure Maps account event subscription."
- },
- {
- "value": "EnterAndExit",
- "description": "Only publish result when user location is considered as crossing geofencing boarder."
- }
- ]
- },
- "x-ms-parameter-location": "method"
- },
- "SpatialUploadUdid": {
- "name": "udid",
- "in": "query",
- "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
- "required": true,
- "type": "string",
- "x-ms-parameter-location": "method"
- },
- "SpatialUploadDataFormat": {
- "name": "dataFormat",
- "description": "Data format of the content being uploaded. Currently, only `geojson` format is supported.",
- "type": "string",
- "in": "query",
- "required": true,
- "enum": [
- "geojson"
- ],
- "x-ms-enum": {
- "name": "SpatialUploadDataFormat",
- "modelAsString": true,
- "values": [
- {
- "value": "geojson",
- "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format."
- }
- ]
- },
- "x-ms-parameter-location": "method"
- },
- "SearchGeofenceRequestBody": {
- "name": "searchGeofenceRequestBody",
- "in": "body",
- "description": "The geofencing GeoJSON data.",
- "required": true,
- "schema": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection"
- },
- "x-ms-parameter-location": "method"
- },
- "ClosestPointRequestBody": {
- "name": "closestPointRequestBody",
- "in": "body",
- "description": "The FeatureCollection of Point geometries from which closest point to source point should be determined. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
- "required": true,
- "schema": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection"
- },
- "x-ms-parameter-location": "method"
- },
- "PointInPolygonRequestBody": {
- "name": "pointInPolygonRequestBody",
- "in": "body",
- "description": "A FeatureCollection with a set of Polygon/MultiPolygon geometries. The maximum number of vertices accepted to form a Polygon is 10,000. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
- "required": true,
- "schema": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection"
- },
- "x-ms-parameter-location": "method"
- }
- },
- "paths": {
- "/spatial/geofence/{format}": {
- "get": {
- "description": "**Search Geofence Get API**\n\n**Applies to:** S1 Pricing tier.\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.
This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples(Request Body) via Data Upload API and replace the [udid] from the sample request below with the udid returned by Data Upload API.\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.",
- "operationId": "Spatial_GetGeofence",
- "x-ms-examples": {
- "GetGeofence": {
- "$ref": "./examples/spatial/Spatial_GetGeofence.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "name": "deviceId",
- "in": "query",
- "description": "ID of the device",
- "required": true,
- "type": "string"
- },
- {
- "name": "udid",
- "in": "query",
- "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated"
- },
- {
- "x-ms-client-name": "altitude",
- "name": "z",
- "in": "query",
- "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion is used. Example: 200.",
- "type": "number"
- },
- {
- "name": "userTime",
- "in": "query",
- "format": "date-time",
- "description": "The user request time. If not presented in the request, the default value is DateTime.Now.",
- "type": "string"
- },
- {
- "x-ms-client-name": "searchBufferInMeters",
- "name": "searchBuffer",
- "in": "query",
- "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.",
- "type": "number",
- "minimum": 0,
- "maximum": 500
- },
- {
- "name": "isAsync",
- "in": "query",
- "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.",
- "type": "boolean"
- },
- {
- "$ref": "#/parameters/GeofenceMode"
- }
- ],
- "responses": {
- "200": {
- "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
- "headers": {
- "X-Correlation-id": {
- "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
- "type": "string"
- }
- },
- "schema": {
- "$ref": "#/definitions/Geofence"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- },
- "post": {
- "description": "**Search Geofence Post API**\n**Applies to:** S1 Pricing tier.\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.
This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).",
- "operationId": "Spatial_PostGeofence",
- "x-ms-examples": {
- "PostGeofence": {
- "$ref": "./examples/spatial/Spatial_PostGeofence.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "name": "deviceId",
- "in": "query",
- "description": "ID of the device",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated"
- },
- {
- "x-ms-client-name": "altitude",
- "name": "z",
- "in": "query",
- "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200.",
- "type": "number"
- },
- {
- "name": "userTime",
- "in": "query",
- "format": "date-time",
- "description": "The user request time. If not presented in the request, the default value is DateTime.UtcNow.",
- "type": "string"
- },
- {
- "name": "searchBuffer",
- "in": "query",
- "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.",
- "type": "number",
- "minimum": 0,
- "maximum": 500
- },
- {
- "name": "isAsync",
- "in": "query",
- "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.",
- "type": "boolean"
- },
- {
- "$ref": "#/parameters/GeofenceMode"
- },
- {
- "$ref": "#/parameters/SearchGeofenceRequestBody"
- }
- ],
- "responses": {
- "200": {
- "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
- "headers": {
- "X-Correlation-id": {
- "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
- "type": "string"
- }
- },
- "schema": {
- "$ref": "#/definitions/Geofence"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- }
- },
- "/spatial/buffer/{format}": {
- "post": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.",
- "operationId": "Spatial_PostBuffer",
- "x-ms-examples": {
- "PostBuffer": {
- "$ref": "./examples/spatial/Spatial_PostBuffer.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "name": "bufferRequestBody",
- "in": "body",
- "description": "The FeatureCollection and the list of distances (one per feature or one for all features).",
- "required": true,
- "schema": {
- "$ref": "#/definitions/BufferRequestBody"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BufferResult"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- },
- "get": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postbuffer#examples) examples(Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.",
- "operationId": "Spatial_GetBuffer",
- "x-ms-examples": {
- "GetBuffer": {
- "$ref": "./examples/spatial/Spatial_GetBuffer.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "$ref": "#/parameters/SpatialUploadUdid"
- },
- {
- "name": "distances",
- "in": "query",
- "description": "The list of distances (one per feature or one for all features), delimited by semicolons. For example, 12.34;-56.78. Positive distance will generate a buffer outside of the feature, whereas negative distance will generate a buffer inside of the feature. If the negative distance larger than the geometry itself, an empty polygon will be returned.",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/BufferResult"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- }
- },
- "/spatial/closestPoint/{format}": {
- "post": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.",
- "operationId": "Spatial_PostClosestPoint",
- "x-ms-examples": {
- "PostClosestPoint": {
- "$ref": "./examples/spatial/Spatial_PostClosestPoint.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated"
- },
- {
- "name": "numberOfClosestPoints",
- "in": "query",
- "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50",
- "type": "integer"
- },
- {
- "$ref": "#/parameters/ClosestPointRequestBody"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/ClosestPointResponse"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- },
- "get": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postclosestpoint#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.",
- "operationId": "Spatial_GetClosestPoint",
- "x-ms-examples": {
- "GetClosestPoint": {
- "$ref": "./examples/spatial/Spatial_GetClosestPoint.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "$ref": "#/parameters/SpatialUploadUdid"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated"
- },
- {
- "name": "numberOfClosestPoints",
- "in": "query",
- "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50",
- "type": "integer"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/ClosestPointResponse"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- }
- },
- "/spatial/pointInPolygon/{format}": {
- "post": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.",
- "operationId": "Spatial_PostPointInPolygon",
- "x-ms-examples": {
- "PostPointInPolygon": {
- "$ref": "./examples/spatial/Spatial_PostPointInPolygon.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated"
- },
- {
- "$ref": "#/parameters/PointInPolygonRequestBody"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/PointInPolygonResult"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- },
- "get": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postpointinpolygon#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.",
- "operationId": "Spatial_EvaluatePointInPolygon",
- "x-ms-examples": {
- "GetPointInPolygon": {
- "$ref": "./examples/spatial/Spatial_EvaluatePointInPolygon.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "$ref": "#/parameters/SpatialUploadUdid"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/PointInPolygonResult"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- }
- },
- "/spatial/greatCircleDistance/{format}": {
- "get": {
- "description": "**Applies to**: S1 pricing tier.\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.",
- "operationId": "Spatial_GetGreatCircleDistance",
- "x-ms-examples": {
- "GetGreatCircleDistance": {
- "$ref": "./examples/spatial/Spatial_GetGreatCircleDistance.json"
- }
- },
- "parameters": [
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
- },
- {
- "$ref": "#/parameters/ApiVersion"
- },
- {
- "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
- },
- {
- "name": "query",
- "in": "query",
- "description": "The Coordinates through which the distance is calculated, delimited by a colon. Two coordinates are required. The first one is the source point coordinate and the last is the target point coordinate. For example, 47.622942,122.316456:57.673988,127.121513",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/GreatCircleDistanceResult"
- }
- },
- "default": {
- "$ref": "../../../Common/preview/1.0/common.json#/responses/default"
- }
- }
- }
- }
- },
- "definitions": {
- "GeofenceGeometry": {
- "description": "The geofencing geometry.",
- "type": "object",
- "readOnly": true,
- "properties": {
- "deviceId": {
- "description": "ID of the device.",
- "type": "string",
- "readOnly": true
- },
- "udId": {
- "x-ms-client-name": "udid",
- "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
- "type": "string",
- "readOnly": true
- },
- "geometryId": {
- "description": "The unique id identifies a geometry.",
- "type": "string",
- "readOnly": true
- },
- "distance": {
- "description": "Distance from the coordinate to the closest border of the geofence (in meters except when special values -999/999 are used). Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.",
- "type": "number",
- "readOnly": true
- },
- "nearestLat": {
- "description": "Latitude of the nearest point of the geometry.",
- "type": "number",
- "readOnly": true
- },
- "nearestLon": {
- "description": "Longitude of the nearest point of the geometry.",
- "type": "number",
- "readOnly": true
- },
- "nearestZ": {
- "x-ms-client-name": "nearestElevation",
- "description": "Sea level in meter of the nearest point on the 2D extrusion geometry. This will only be presented in response when value is provided for 'zInMeter' in the request.",
- "type": "number",
- "readOnly": true
- }
- }
- },
- "Geofence": {
- "description": "This object is returned from a geofence proximity call.",
- "type": "object",
- "properties": {
- "geometries": {
- "description": "Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position.",
- "type": "array",
- "readOnly": true,
- "items": {
- "$ref": "#/definitions/GeofenceGeometry"
- }
- },
- "expiredGeofenceGeometryId": {
- "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.",
- "type": "array",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "invalidPeriodGeofenceGeometryId": {
- "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.",
- "type": "array",
- "readOnly": true,
- "items": {
- "type": "string"
- }
- },
- "isEventPublished": {
- "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. This will only be presented in response when 'isAsync' query parameter is set to true.",
- "type": "boolean",
- "readOnly": true
- }
- }
- },
- "BufferRequestBody": {
- "description": "An object with a FeatureCollection and a list of distances. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
- "type": "object",
- "properties": {
- "geometries": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection"
- },
- "distances": {
- "description": "List of the distances to compute the buffer for, one-to-one per Feature in the collection, or one for all Features in the collection.",
- "type": "array",
- "items": {
- "type": "number"
- }
- }
- }
- },
- "BufferSummary": {
- "type": "object",
- "readOnly": true,
- "properties": {
- "udid": {
- "description": "The udid for the user data if one exists",
- "type": "string",
- "readOnly": true
- },
- "information": {
- "description": "The information about what happened during the call.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "BufferResult": {
- "description": "This object is returned from a successful Spatial Buffer call.",
- "type": "object",
- "properties": {
- "summary": {
- "$ref": "#/definitions/BufferSummary"
- },
- "result": {
- "x-ms-client-name": "features",
- "description": "The FeatureCollection of buffers for the input.",
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection"
- }
- }
- },
- "ClosestPointResponse": {
- "description": "This object is returned from a successful Spatial Closest Point call",
- "type": "object",
- "properties": {
- "summary": {
- "$ref": "#/definitions/ClosestPointSummary"
- },
- "result": {
- "description": "Closest Point Result Array",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ClosestPoint"
- }
- }
- }
- },
- "ClosestPointSummary": {
- "description": "Closest Point Summary object",
- "type": "object",
- "readOnly": true,
- "properties": {
- "sourcePoint": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
- },
- "udid": {
- "description": "A unique data id (udid) for the uploaded content",
- "type": "string",
- "readOnly": true
- },
- "information": {
- "description": "Processing information",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ClosestPoint": {
- "description": "Closest Point Result Entry Object",
- "type": "object",
- "readOnly": true,
- "properties": {
- "distanceInMeters": {
- "description": "The distance in meters from the source point to the closest point",
- "type": "number",
- "readOnly": true
- },
- "position": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
- },
- "geometryId": {
- "description": "The unique id identifies a geometry",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "PointInPolygonResult": {
- "description": "Returns true if point is within the polygon, false otherwise",
- "type": "object",
- "properties": {
- "summary": {
- "$ref": "#/definitions/PointInPolygonSummary"
- },
- "result": {
- "description": "Point In Polygon Result Object",
- "type": "object",
- "properties": {
- "pointInPolygons": {
- "x-ms-client-name": "isPointInPolygons",
- "description": "Point In Polygons Property",
- "type": "boolean",
- "readOnly": true
- },
- "intersectingGeometries": {
- "description": "Geometries array",
- "type": "array",
- "readOnly": true,
- "items": {
- "$ref": "#/definitions/GeometryId"
- }
- }
- }
- }
- }
- },
- "PointInPolygonSummary": {
- "description": "Point In Polygon Summary object",
- "type": "object",
- "readOnly": true,
- "properties": {
- "sourcePoint": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
- },
- "udid": {
- "description": "A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)",
- "type": "string",
- "readOnly": true
- },
- "information": {
- "description": "Processing information",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "GeometryId": {
- "description": "The Spatial geometry",
- "type": "string",
- "readOnly": true
- },
- "GreatCircleDistanceSummary": {
- "description": "Summary object",
- "type": "object",
- "readOnly": true,
- "properties": {
- "sourcePoint": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
- },
- "targetPoint": {
- "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
- }
- }
- },
- "GreatCircleDistanceResult": {
- "description": "This object is returned from a successful Great Circle Distance call",
- "type": "object",
- "properties": {
- "summary": {
- "$ref": "#/definitions/GreatCircleDistanceSummary"
- },
- "result": {
- "description": "Result Object",
- "type": "object",
- "readOnly": true,
- "properties": {
- "distanceInMeters": {
- "description": "The great circle distance in meters from the source point to the target point",
- "type": "number",
- "readOnly": true
- }
- }
- }
- }
- }
- }
-}