{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Spatial API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Spatial", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Spatial Geofence Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/spatial/geofence/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "deviceId", "value": "", "type": "query", "description": "ID of the device" }, { "name": "udId", "value": "", "type": "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." }, { "name": "lat", "value": "", "type": "query", "description": "The latitude of the location being passed. Example: 48.36." }, { "name": "lon", "value": "", "type": "query", "description": "The longitude of the location being passed. Example: -124.63." }, { "name": "z", "value": "", "type": "query", "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion is used. Example: 200." }, { "name": "userTime", "value": "", "type": "query", "description": "The user request time. If not presented in the request, the default value is DateTime.Now." }, { "name": "searchBuffer", "value": "", "type": "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." }, { "name": "isAsync", "value": "", "type": "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." }, { "name": "mode", "value": "", "type": "query", "description": "Mode of the geofencing async event mechanism." } ] }, "docs": "**Search Geofence Get API**

**Applies to:** S1 Pricing tier.

The Geofence Get API allows you to retrieve the proximity of a coordinate to a
geofence that has been uploaded to the Data service. You can use the
[Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload
a geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson)
for more details on the geofence data f" }, { "info": { "name": "Microsoft Azure Post Spatial Geofence Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/spatial/geofence/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "deviceId", "value": "", "type": "query", "description": "ID of the device" }, { "name": "lat", "value": "", "type": "query", "description": "The latitude of the location being passed. Example: 48.36." }, { "name": "lon", "value": "", "type": "query", "description": "The longitude of the location being passed. Example: -124.63." }, { "name": "z", "value": "", "type": "query", "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200." }, { "name": "userTime", "value": "", "type": "query", "description": "The user request time. If not presented in the request, the default value is DateTime.UtcNow." }, { "name": "searchBuffer", "value": "", "type": "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." }, { "name": "isAsync", "value": "", "type": "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." }, { "name": "mode", "value": "", "type": "query", "description": "Mode of the geofencing async event mechanism." } ] }, "docs": "**Search Geofence Post API**
**Applies to:** S1 Pricing tier.
The 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) " }, { "info": { "name": "Microsoft Azure Get Spatial Buffer Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/spatial/buffer/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "udid", "value": "", "type": "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." }, { "name": "distances", "value": "", "type": "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." } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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" }, { "info": { "name": "Microsoft Azure Post Spatial Buffer Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/spatial/buffer/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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" }, { "info": { "name": "Microsoft Azure Get Spatial Closestpoint Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/spatial/closestPoint/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "udid", "value": "", "type": "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." }, { "name": "lat", "value": "", "type": "query", "description": "The base point latitude of the location being passed. Example: 47.622942." }, { "name": "lon", "value": "", "type": "query", "description": "The base point longitude of the location being passed. Example: -122.316456." }, { "name": "numberOfClosestPoints", "value": "", "type": "query", "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50" } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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 max" }, { "info": { "name": "Microsoft Azure Post Spatial Closestpoint Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/spatial/closestPoint/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "lat", "value": "", "type": "query", "description": "The base point latitude of the location being passed. Example: 47.622942." }, { "name": "lon", "value": "", "type": "query", "description": "The base point longitude of the location being passed. Example: -122.316456." }, { "name": "numberOfClosestPoints", "value": "", "type": "query", "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50" } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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," }, { "info": { "name": "Microsoft Azure Get Spatial Pointinpolygon Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/spatial/pointInPolygon/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "udid", "value": "", "type": "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." }, { "name": "lat", "value": "", "type": "query", "description": "The base point latitude of the location being passed. Example: 47.622942." }, { "name": "lon", "value": "", "type": "query", "description": "The base point longitude of the location being passed. Example: -122.316456." } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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, t" }, { "info": { "name": "Microsoft Azure Post Spatial Pointinpolygon Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/spatial/pointInPolygon/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "lat", "value": "", "type": "query", "description": "The base point latitude of the location being passed. Example: 47.622942." }, { "name": "lon", "value": "", "type": "query", "description": "The base point longitude of the location being passed. Example: -122.316456." } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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 ge" }, { "info": { "name": "Microsoft Azure Get Spatial Greatcircledistance Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/spatial/greatCircleDistance/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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" } ] }, "docs": "**Applies to**: S1 pricing tier.

This 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." } ] } ], "bundled": true }