@azure-rest/maps-route 1.0.0-beta.3 → 1.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -39
- package/dist/index.js +160 -77
- package/dist/index.js.map +1 -1
- package/dist-esm/src/helpers.js +1 -1
- package/dist-esm/src/helpers.js.map +1 -1
- package/dist-esm/src/index.js +2 -2
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/mapsRoute.js +5 -5
- package/dist-esm/src/mapsRoute.js.map +1 -1
- package/package.json +29 -33
- package/review/maps-route.api.md +114 -91
- package/types/maps-route-rest.d.ts +499 -271
- package/dist-esm/src/generated/clientDefinitions.js +0 -4
- package/dist-esm/src/generated/clientDefinitions.js.map +0 -1
- package/dist-esm/src/generated/index.js +0 -13
- package/dist-esm/src/generated/index.js.map +0 -1
- package/dist-esm/src/generated/isUnexpected.js +0 -76
- package/dist-esm/src/generated/isUnexpected.js.map +0 -1
- package/dist-esm/src/generated/mapsRouteClient.js +0 -30
- package/dist-esm/src/generated/mapsRouteClient.js.map +0 -1
- package/dist-esm/src/generated/models.js +0 -4
- package/dist-esm/src/generated/models.js.map +0 -1
- package/dist-esm/src/generated/outputModels.js +0 -4
- package/dist-esm/src/generated/outputModels.js.map +0 -1
- package/dist-esm/src/generated/parameters.js +0 -4
- package/dist-esm/src/generated/parameters.js.map +0 -1
- package/dist-esm/src/generated/pollingHelper.js +0 -55
- package/dist-esm/src/generated/pollingHelper.js.map +0 -1
- package/dist-esm/src/generated/responses.js +0 -4
- package/dist-esm/src/generated/responses.js.map +0 -1
|
@@ -1,16 +1,17 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { AbortSignalLike } from '@azure/abort-controller';
|
|
2
|
+
import type { AzureKeyCredential } from '@azure/core-auth';
|
|
3
|
+
import type { AzureSASCredential } from '@azure/core-auth';
|
|
4
|
+
import { CancelOnProgress } from '@azure/core-lro';
|
|
3
5
|
import { Client } from '@azure-rest/core-client';
|
|
4
6
|
import { ClientOptions } from '@azure-rest/core-client';
|
|
7
|
+
import { CreateHttpPollerOptions } from '@azure/core-lro';
|
|
5
8
|
import { HttpResponse } from '@azure-rest/core-client';
|
|
6
|
-
import { LatLon } from '@azure/maps-common';
|
|
7
|
-
import {
|
|
8
|
-
import { PollerLike } from '@azure/core-lro';
|
|
9
|
-
import { PollOperationState } from '@azure/core-lro';
|
|
9
|
+
import type { LatLon } from '@azure/maps-common';
|
|
10
|
+
import { OperationState } from '@azure/core-lro';
|
|
10
11
|
import { RawHttpHeaders } from '@azure/core-rest-pipeline';
|
|
11
12
|
import { RequestParameters } from '@azure-rest/core-client';
|
|
12
13
|
import { StreamableMethod } from '@azure-rest/core-client';
|
|
13
|
-
import { TokenCredential } from '@azure/core-auth';
|
|
14
|
+
import type { TokenCredential } from '@azure/core-auth';
|
|
14
15
|
|
|
15
16
|
/** This type represents the request body for the Batch service. */
|
|
16
17
|
export declare interface BatchRequest {
|
|
@@ -27,23 +28,25 @@ export declare interface BatchRequestItem {
|
|
|
27
28
|
/** An item returned from Batch API. Extend with 'response' property. */
|
|
28
29
|
export declare interface BatchResultItemOutput {
|
|
29
30
|
/** HTTP request status code. */
|
|
30
|
-
statusCode: number;
|
|
31
|
+
readonly statusCode: number;
|
|
31
32
|
}
|
|
32
33
|
|
|
33
34
|
/** This object is returned from a successful Batch service call. Extend with 'batchItems' property. */
|
|
34
35
|
export declare interface BatchResultOutput {
|
|
35
36
|
/** Summary of the results for the batch request */
|
|
36
|
-
summary: BatchResultSummaryOutput;
|
|
37
|
+
readonly summary: BatchResultSummaryOutput;
|
|
37
38
|
}
|
|
38
39
|
|
|
39
40
|
/** Summary of the results for the batch request */
|
|
40
41
|
export declare interface BatchResultSummaryOutput {
|
|
41
42
|
/** Number of successful requests in the batch */
|
|
42
|
-
successfulRequests: number;
|
|
43
|
+
readonly successfulRequests: number;
|
|
43
44
|
/** Total number of requests in the batch */
|
|
44
|
-
totalRequests: number;
|
|
45
|
+
readonly totalRequests: number;
|
|
45
46
|
}
|
|
46
47
|
|
|
48
|
+
export declare function buildMultiCollection(items: string[], parameterName: string): string;
|
|
49
|
+
|
|
47
50
|
/**
|
|
48
51
|
* Create a batch request body of a bunch of route direction requests.
|
|
49
52
|
*
|
|
@@ -55,17 +58,17 @@ export declare function createRouteDirectionsBatchRequest(queryParamProperties:
|
|
|
55
58
|
/** Effective parameter or data used when calling this Route API. */
|
|
56
59
|
export declare interface EffectiveSettingOutput {
|
|
57
60
|
/** Name of the parameter used. */
|
|
58
|
-
key: string;
|
|
61
|
+
readonly key: string;
|
|
59
62
|
/** Value of the parameter used. */
|
|
60
|
-
value: string;
|
|
63
|
+
readonly value: string;
|
|
61
64
|
}
|
|
62
65
|
|
|
63
66
|
/** The error detail. */
|
|
64
67
|
export declare interface ErrorDetailOutput {
|
|
65
68
|
/** The error code. */
|
|
66
|
-
code?: string;
|
|
69
|
+
readonly code?: string;
|
|
67
70
|
/** The error message. */
|
|
68
|
-
message?: string;
|
|
71
|
+
readonly message?: string;
|
|
69
72
|
}
|
|
70
73
|
|
|
71
74
|
/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
|
|
@@ -195,25 +198,21 @@ export declare interface GeoJsonPolygonData {
|
|
|
195
198
|
* @param options - Options to set a resume state or custom polling interval.
|
|
196
199
|
* @returns - A poller object to poll for operation state updates and eventually get the final response.
|
|
197
200
|
*/
|
|
198
|
-
export declare function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?:
|
|
201
|
+
export declare function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
199
202
|
|
|
200
203
|
export declare interface GetRouteDirections {
|
|
201
204
|
/**
|
|
202
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
203
|
-
*
|
|
204
205
|
*
|
|
205
|
-
*
|
|
206
|
+
* The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
206
207
|
*
|
|
207
208
|
* Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
|
|
208
209
|
*
|
|
209
|
-
* Routing service provides a set of parameters for a detailed description of vehicle-specific
|
|
210
|
+
* Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model).
|
|
210
211
|
*/
|
|
211
212
|
get(options: RouteGetRouteDirectionsParameters): StreamableMethod<RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse>;
|
|
212
213
|
/**
|
|
213
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
214
214
|
*
|
|
215
|
-
*
|
|
216
|
-
* Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
215
|
+
* The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
217
216
|
*
|
|
218
217
|
* Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
|
|
219
218
|
*
|
|
@@ -224,14 +223,10 @@ export declare interface GetRouteDirections {
|
|
|
224
223
|
|
|
225
224
|
export declare interface GetRouteRange {
|
|
226
225
|
/**
|
|
227
|
-
* __Route Range (Isochrone) API__
|
|
228
|
-
*
|
|
229
226
|
*
|
|
230
|
-
*
|
|
227
|
+
* The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.
|
|
231
228
|
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
* The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.
|
|
229
|
+
* The returned polygon can be used for further processing such as [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to search for POIs within the provided isochrone.
|
|
235
230
|
*/
|
|
236
231
|
get(options: RouteGetRouteRangeParameters): StreamableMethod<RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse>;
|
|
237
232
|
}
|
|
@@ -311,16 +306,17 @@ export declare type MapsRouteClient = Client & {
|
|
|
311
306
|
path: Routes;
|
|
312
307
|
};
|
|
313
308
|
|
|
309
|
+
/** The optional parameters for the client */
|
|
310
|
+
export declare interface MapsRouteClientOptions extends ClientOptions {
|
|
311
|
+
/** The api version option of the client */
|
|
312
|
+
apiVersion?: string;
|
|
313
|
+
}
|
|
314
|
+
|
|
314
315
|
export declare interface RequestRouteDirectionsBatch {
|
|
315
316
|
/**
|
|
316
|
-
* **Route Directions Batch API**
|
|
317
|
-
*
|
|
318
317
|
*
|
|
319
|
-
* **
|
|
318
|
+
* The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).
|
|
320
319
|
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
324
320
|
* ### Submit Asynchronous Batch Request
|
|
325
321
|
* The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
|
|
326
322
|
* - It allows the retrieval of results in a separate call (multiple downloads are possible).
|
|
@@ -328,10 +324,13 @@ export declare interface RequestRouteDirectionsBatch {
|
|
|
328
324
|
* - The number of batch items is limited to **700** for this API.
|
|
329
325
|
*
|
|
330
326
|
* When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.
|
|
331
|
-
* The asynchronous responses are stored for **
|
|
327
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
332
328
|
*
|
|
333
|
-
* Please note that asynchronous batch request is a long-running
|
|
334
|
-
* 1. Client sends a Route Directions Batch `POST` request to Azure Maps
|
|
329
|
+
* Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
|
|
330
|
+
* 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
|
|
331
|
+
* ```
|
|
332
|
+
* POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
|
|
333
|
+
* ```
|
|
335
334
|
* 2. The server will respond with one of the following:
|
|
336
335
|
*
|
|
337
336
|
* > HTTP `202 Accepted` - Batch request has been accepted.
|
|
@@ -340,9 +339,9 @@ export declare interface RequestRouteDirectionsBatch {
|
|
|
340
339
|
*
|
|
341
340
|
* 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.
|
|
342
341
|
* This status URI looks like following:
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
342
|
+
* ```
|
|
343
|
+
* GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
|
|
344
|
+
* ```
|
|
346
345
|
* 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
|
|
347
346
|
*
|
|
348
347
|
* ### POST Body for Batch Request
|
|
@@ -465,7 +464,8 @@ export declare interface RequestRouteDirectionsBatch {
|
|
|
465
464
|
*/
|
|
466
465
|
post(options: RouteRequestRouteDirectionsBatchParameters): StreamableMethod<RouteRequestRouteDirectionsBatch200Response | RouteRequestRouteDirectionsBatch202Response>;
|
|
467
466
|
/**
|
|
468
|
-
*
|
|
467
|
+
*
|
|
468
|
+
* The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
469
469
|
*
|
|
470
470
|
* ### Download Asynchronous Batch Results
|
|
471
471
|
* To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
|
|
@@ -570,14 +570,8 @@ export declare interface RequestRouteDirectionsBatch {
|
|
|
570
570
|
|
|
571
571
|
export declare interface RequestRouteDirectionsBatchSync {
|
|
572
572
|
/**
|
|
573
|
-
* **Route Directions Batch API**
|
|
574
573
|
*
|
|
575
|
-
*
|
|
576
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
577
|
-
*
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
574
|
+
* The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
|
|
581
575
|
* ### Submit Synchronous Batch Request
|
|
582
576
|
* The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
|
|
583
577
|
* ```
|
|
@@ -671,9 +665,7 @@ export declare interface RequestRouteDirectionsBatchSync {
|
|
|
671
665
|
export declare interface RequestRouteMatrix {
|
|
672
666
|
/**
|
|
673
667
|
*
|
|
674
|
-
*
|
|
675
|
-
*
|
|
676
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
668
|
+
* The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
677
669
|
*
|
|
678
670
|
*
|
|
679
671
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -681,6 +673,9 @@ export declare interface RequestRouteMatrix {
|
|
|
681
673
|
*
|
|
682
674
|
* The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
|
|
683
675
|
*
|
|
676
|
+
* > [!NOTE]
|
|
677
|
+
* > All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
|
|
678
|
+
*
|
|
684
679
|
*
|
|
685
680
|
*
|
|
686
681
|
* ### Submit Synchronous Route Matrix Request
|
|
@@ -697,7 +692,7 @@ export declare interface RequestRouteMatrix {
|
|
|
697
692
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
698
693
|
*
|
|
699
694
|
*
|
|
700
|
-
* The asynchronous responses are stored for **
|
|
695
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
701
696
|
*
|
|
702
697
|
*
|
|
703
698
|
*
|
|
@@ -742,9 +737,53 @@ export declare interface RequestRouteMatrix {
|
|
|
742
737
|
*/
|
|
743
738
|
post(options: RouteRequestRouteMatrixParameters): StreamableMethod<RouteRequestRouteMatrix200Response | RouteRequestRouteMatrix202Response>;
|
|
744
739
|
/**
|
|
745
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
746
740
|
*
|
|
747
|
-
*
|
|
741
|
+
* The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).
|
|
742
|
+
*
|
|
743
|
+
* For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
744
|
+
*
|
|
745
|
+
*
|
|
746
|
+
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
747
|
+
*
|
|
748
|
+
*
|
|
749
|
+
* The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
|
|
750
|
+
*
|
|
751
|
+
*
|
|
752
|
+
*
|
|
753
|
+
* ### Submit Synchronous Route Matrix Request
|
|
754
|
+
* If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
|
|
755
|
+
*
|
|
756
|
+
* ```
|
|
757
|
+
* GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
|
|
758
|
+
* ```
|
|
759
|
+
*
|
|
760
|
+
* ### Submit Asynchronous Route Matrix Request
|
|
761
|
+
* The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
|
|
762
|
+
*
|
|
763
|
+
*
|
|
764
|
+
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
765
|
+
*
|
|
766
|
+
*
|
|
767
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
768
|
+
*
|
|
769
|
+
*
|
|
770
|
+
*
|
|
771
|
+
*
|
|
772
|
+
* ```
|
|
773
|
+
* GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
|
|
774
|
+
* ```
|
|
775
|
+
*
|
|
776
|
+
* Here's a typical sequence of asynchronous operations:
|
|
777
|
+
* 1. Client sends a Route Matrix GET request to Azure Maps
|
|
778
|
+
*
|
|
779
|
+
* 2. The server will respond with one of the following:
|
|
780
|
+
*
|
|
781
|
+
* > HTTP `202 Accepted` - Route Matrix request has been accepted.
|
|
782
|
+
*
|
|
783
|
+
* > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
|
|
784
|
+
*
|
|
785
|
+
*
|
|
786
|
+
* 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
|
|
748
787
|
*
|
|
749
788
|
* ```
|
|
750
789
|
* GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
|
|
@@ -754,7 +793,7 @@ export declare interface RequestRouteMatrix {
|
|
|
754
793
|
* 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
|
|
755
794
|
*
|
|
756
795
|
* ### Download Sync Results
|
|
757
|
-
* When you make a
|
|
796
|
+
* When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
|
|
758
797
|
*
|
|
759
798
|
* ### Download Async Results
|
|
760
799
|
* When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:
|
|
@@ -774,9 +813,7 @@ export declare interface RequestRouteMatrix {
|
|
|
774
813
|
export declare interface RequestRouteMatrixSync {
|
|
775
814
|
/**
|
|
776
815
|
*
|
|
777
|
-
*
|
|
778
|
-
*
|
|
779
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
816
|
+
* The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
780
817
|
*
|
|
781
818
|
*
|
|
782
819
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -800,7 +837,7 @@ export declare interface RequestRouteMatrixSync {
|
|
|
800
837
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
801
838
|
*
|
|
802
839
|
*
|
|
803
|
-
* The asynchronous responses are stored for **
|
|
840
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
804
841
|
*
|
|
805
842
|
*
|
|
806
843
|
*
|
|
@@ -859,9 +896,9 @@ export declare interface RouteDirectionParameters {
|
|
|
859
896
|
* ignored for the calculation of the reference route's travel time and traffic delay.
|
|
860
897
|
*/
|
|
861
898
|
supportingPoints?: Record<string, unknown>;
|
|
862
|
-
/** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
|
|
899
|
+
/** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries/regions not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
|
|
863
900
|
avoidVignette?: Array<string>;
|
|
864
|
-
/** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
|
|
901
|
+
/** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries/regions X is equivalent to specifying **avoidVignette** with all countries/regions but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
|
|
865
902
|
allowVignette?: Array<string>;
|
|
866
903
|
/** A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude. */
|
|
867
904
|
avoidAreas?: GeoJsonMultiPolygon;
|
|
@@ -870,7 +907,7 @@ export declare interface RouteDirectionParameters {
|
|
|
870
907
|
/** An item returned from Route Directions Batch service call. */
|
|
871
908
|
export declare interface RouteDirectionsBatchItemOutput extends BatchResultItemOutput {
|
|
872
909
|
/** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */
|
|
873
|
-
response: RouteDirectionsBatchItemResponseOutput;
|
|
910
|
+
readonly response: RouteDirectionsBatchItemResponseOutput;
|
|
874
911
|
}
|
|
875
912
|
|
|
876
913
|
/** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */
|
|
@@ -880,15 +917,15 @@ export declare interface RouteDirectionsBatchItemResponseOutput extends RouteDir
|
|
|
880
917
|
/** This object is returned from a successful Route Directions Batch service call. */
|
|
881
918
|
export declare interface RouteDirectionsBatchResultOutput extends BatchResultOutput {
|
|
882
919
|
/** Array containing the batch results. */
|
|
883
|
-
batchItems: Array<RouteDirectionsBatchItemOutput>;
|
|
920
|
+
readonly batchItems: Array<RouteDirectionsBatchItemOutput>;
|
|
884
921
|
}
|
|
885
922
|
|
|
886
923
|
/** This object is returned from a successful Route Directions call */
|
|
887
924
|
export declare interface RouteDirectionsOutput {
|
|
888
925
|
/** Format Version property */
|
|
889
|
-
formatVersion?: string;
|
|
926
|
+
readonly formatVersion?: string;
|
|
890
927
|
/** Routes array */
|
|
891
|
-
routes: Array<RouteOutput>;
|
|
928
|
+
readonly routes: Array<RouteOutput>;
|
|
892
929
|
/**
|
|
893
930
|
* Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:
|
|
894
931
|
*
|
|
@@ -902,20 +939,18 @@ export declare interface RouteDirectionsOutput {
|
|
|
902
939
|
*
|
|
903
940
|
* means that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is "first, second, third" while the optimized is "second, third, first".
|
|
904
941
|
*/
|
|
905
|
-
optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
|
|
942
|
+
readonly optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
|
|
906
943
|
/** Reports the effective settings used in the current call. */
|
|
907
944
|
report?: RouteReportOutput;
|
|
908
945
|
}
|
|
909
946
|
|
|
910
947
|
/**
|
|
911
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
912
948
|
*
|
|
913
|
-
*
|
|
914
|
-
* Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
949
|
+
* The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
915
950
|
*
|
|
916
951
|
* Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
|
|
917
952
|
*
|
|
918
|
-
* Routing service provides a set of parameters for a detailed description of vehicle-specific
|
|
953
|
+
* Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model).
|
|
919
954
|
*/
|
|
920
955
|
export declare interface RouteGetRouteDirections200Response extends HttpResponse {
|
|
921
956
|
status: "200";
|
|
@@ -923,7 +958,8 @@ export declare interface RouteGetRouteDirections200Response extends HttpResponse
|
|
|
923
958
|
}
|
|
924
959
|
|
|
925
960
|
/**
|
|
926
|
-
*
|
|
961
|
+
*
|
|
962
|
+
* The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
927
963
|
*
|
|
928
964
|
* ### Download Asynchronous Batch Results
|
|
929
965
|
* To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
|
|
@@ -1029,12 +1065,13 @@ export declare interface RouteGetRouteDirectionsBatch200Response extends HttpRes
|
|
|
1029
1065
|
}
|
|
1030
1066
|
|
|
1031
1067
|
export declare interface RouteGetRouteDirectionsBatch202Headers {
|
|
1032
|
-
/** New URL to check for the results of the long
|
|
1068
|
+
/** New URL to check for the results of the long-running operation. */
|
|
1033
1069
|
location?: string;
|
|
1034
1070
|
}
|
|
1035
1071
|
|
|
1036
1072
|
/**
|
|
1037
|
-
*
|
|
1073
|
+
*
|
|
1074
|
+
* The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
1038
1075
|
*
|
|
1039
1076
|
* ### Download Asynchronous Batch Results
|
|
1040
1077
|
* To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
|
|
@@ -1136,21 +1173,18 @@ export declare interface RouteGetRouteDirectionsBatch202Headers {
|
|
|
1136
1173
|
*/
|
|
1137
1174
|
export declare interface RouteGetRouteDirectionsBatch202Response extends HttpResponse {
|
|
1138
1175
|
status: "202";
|
|
1139
|
-
body: Record<string, unknown>;
|
|
1140
1176
|
headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers;
|
|
1141
1177
|
}
|
|
1142
1178
|
|
|
1143
1179
|
export declare type RouteGetRouteDirectionsBatchParameters = RequestParameters;
|
|
1144
1180
|
|
|
1145
1181
|
/**
|
|
1146
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1147
|
-
*
|
|
1148
1182
|
*
|
|
1149
|
-
*
|
|
1183
|
+
* The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
1150
1184
|
*
|
|
1151
1185
|
* Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
|
|
1152
1186
|
*
|
|
1153
|
-
* Routing service provides a set of parameters for a detailed description of vehicle-specific
|
|
1187
|
+
* Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model).
|
|
1154
1188
|
*/
|
|
1155
1189
|
export declare interface RouteGetRouteDirectionsDefaultResponse extends HttpResponse {
|
|
1156
1190
|
status: string;
|
|
@@ -1172,9 +1206,27 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1172
1206
|
alternativeType?: "anyRoute" | "betterRoute";
|
|
1173
1207
|
/** All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt */
|
|
1174
1208
|
minDeviationDistance?: number;
|
|
1175
|
-
/**
|
|
1209
|
+
/**
|
|
1210
|
+
* The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
|
|
1211
|
+
*
|
|
1212
|
+
* Examples:
|
|
1213
|
+
* * 2023-12-19T16:39:57
|
|
1214
|
+
* * 2023-12-19T16:39:57-08:00
|
|
1215
|
+
*
|
|
1216
|
+
* The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
|
|
1217
|
+
*/
|
|
1176
1218
|
arriveAt?: Date | string;
|
|
1177
|
-
/**
|
|
1219
|
+
/**
|
|
1220
|
+
* The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
|
|
1221
|
+
* * Default value: now
|
|
1222
|
+
* * Other value: `dateTime`
|
|
1223
|
+
*
|
|
1224
|
+
* Examples:
|
|
1225
|
+
* * 2023-12-19T16:39:57
|
|
1226
|
+
* * 2023-12-19T16:39:57-08:00
|
|
1227
|
+
*
|
|
1228
|
+
* The `departAt` parameter cannot be used in conjunction with `arriveAt`.
|
|
1229
|
+
*/
|
|
1178
1230
|
departAt?: Date | string;
|
|
1179
1231
|
/**
|
|
1180
1232
|
* All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:
|
|
@@ -1195,7 +1247,7 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1195
1247
|
* - The _vehicleHeading_ is ignored.
|
|
1196
1248
|
*/
|
|
1197
1249
|
minDeviationTime?: number;
|
|
1198
|
-
/** If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none */
|
|
1250
|
+
/** If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none. */
|
|
1199
1251
|
instructionsType?: "coded" | "text" | "tagged";
|
|
1200
1252
|
/**
|
|
1201
1253
|
* The language parameter determines the language of the guidance messages. Proper nouns (the names of streets, plazas, etc.) are returned in the specified language, or if that is not available, they are returned in an available language that is close to it. Allowed values are (a subset of) the IETF language tags. The currently supported languages are listed in the [Supported languages section](https://docs.microsoft.com/azure/azure-maps/supported-languages).
|
|
@@ -1205,7 +1257,7 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1205
1257
|
language?: string;
|
|
1206
1258
|
/** Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Yields best results when used in conjunction with routeType _shortest_. Notice that origin and destination are excluded from the optimized waypoint indices. To include origin and destination in the response, please increase all the indices by 1 to account for the origin, and then add the destination as the final index. Possible values are true or false. True computes a better order if possible, but is not allowed to be used in conjunction with maxAlternatives value greater than 0 or in conjunction with circle waypoints. False will use the locations in the given order and not allowed to be used in conjunction with routeRepresentation _none_. */
|
|
1207
1259
|
computeBestOrder?: boolean;
|
|
1208
|
-
/** Specifies the representation of the set of routes provided as response.
|
|
1260
|
+
/** Specifies the representation of the set of routes provided as response. */
|
|
1209
1261
|
routeRepresentation?: "polyline" | "summaryOnly" | "none";
|
|
1210
1262
|
/** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
|
|
1211
1263
|
computeTravelTimeFor?: "none" | "all";
|
|
@@ -1213,8 +1265,8 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1213
1265
|
vehicleHeading?: number;
|
|
1214
1266
|
/** Specifies which data should be reported for diagnosis purposes. The only possible value is _effectiveSettings_. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller. */
|
|
1215
1267
|
report?: "effectiveSettings";
|
|
1216
|
-
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned.
|
|
1217
|
-
sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"
|
|
1268
|
+
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
|
|
1269
|
+
sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
|
|
1218
1270
|
/** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
|
|
1219
1271
|
vehicleAxleWeight?: number;
|
|
1220
1272
|
/** Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. */
|
|
@@ -1251,9 +1303,9 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1251
1303
|
windingness?: "low" | "normal" | "high";
|
|
1252
1304
|
/** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
|
|
1253
1305
|
hilliness?: "low" | "normal" | "high";
|
|
1254
|
-
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.
|
|
1306
|
+
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
|
|
1255
1307
|
travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
|
|
1256
|
-
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In
|
|
1308
|
+
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
|
|
1257
1309
|
avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
|
|
1258
1310
|
/**
|
|
1259
1311
|
* Possible values:
|
|
@@ -1264,7 +1316,7 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1264
1316
|
traffic?: boolean;
|
|
1265
1317
|
/** The type of route requested. */
|
|
1266
1318
|
routeType?: "fastest" | "shortest" | "eco" | "thrilling";
|
|
1267
|
-
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
1319
|
+
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
1268
1320
|
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
|
|
1269
1321
|
/** Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. */
|
|
1270
1322
|
vehicleEngineType?: "combustion" | "electric";
|
|
@@ -1406,10 +1458,8 @@ export declare interface RouteGetRouteDirectionsQueryParamProperties {
|
|
|
1406
1458
|
}
|
|
1407
1459
|
|
|
1408
1460
|
/**
|
|
1409
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1410
1461
|
*
|
|
1411
|
-
*
|
|
1412
|
-
* Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
1462
|
+
* The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
1413
1463
|
*
|
|
1414
1464
|
* Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
|
|
1415
1465
|
*
|
|
@@ -1436,10 +1486,8 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersBodyPara
|
|
|
1436
1486
|
}
|
|
1437
1487
|
|
|
1438
1488
|
/**
|
|
1439
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1440
|
-
*
|
|
1441
1489
|
*
|
|
1442
|
-
*
|
|
1490
|
+
* The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
|
|
1443
1491
|
*
|
|
1444
1492
|
* Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
|
|
1445
1493
|
*
|
|
@@ -1489,13 +1537,13 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryPar
|
|
|
1489
1537
|
* - The _vehicleHeading_ is ignored.
|
|
1490
1538
|
*/
|
|
1491
1539
|
minDeviationTime?: number;
|
|
1492
|
-
/** If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none */
|
|
1540
|
+
/** If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none. */
|
|
1493
1541
|
instructionsType?: "coded" | "text" | "tagged";
|
|
1494
1542
|
/** The language parameter determines the language of the guidance messages. It does not affect proper nouns (the names of streets, plazas, etc.) It has no effect when instructionsType=coded. Allowed values are (a subset of) the IETF language tags described */
|
|
1495
1543
|
language?: string;
|
|
1496
1544
|
/** Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Yields best results when used in conjunction with routeType _shortest_. Notice that origin and destination are excluded from the optimized waypoint indices. To include origin and destination in the response, please increase all the indices by 1 to account for the origin, and then add the destination as the final index. Possible values are true or false. True computes a better order if possible, but is not allowed to be used in conjunction with maxAlternatives value greater than 0 or in conjunction with circle waypoints. False will use the locations in the given order and not allowed to be used in conjunction with routeRepresentation _none_. */
|
|
1497
1545
|
computeBestOrder?: boolean;
|
|
1498
|
-
/** Specifies the representation of the set of routes provided as response.
|
|
1546
|
+
/** Specifies the representation of the set of routes provided as response. */
|
|
1499
1547
|
routeRepresentation?: "polyline" | "summaryOnly" | "none";
|
|
1500
1548
|
/** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
|
|
1501
1549
|
computeTravelTimeFor?: "none" | "all";
|
|
@@ -1503,11 +1551,29 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryPar
|
|
|
1503
1551
|
vehicleHeading?: number;
|
|
1504
1552
|
/** Specifies which data should be reported for diagnosis purposes. The only possible value is _effectiveSettings_. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller. */
|
|
1505
1553
|
report?: "effectiveSettings";
|
|
1506
|
-
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned.
|
|
1507
|
-
sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"
|
|
1508
|
-
/**
|
|
1554
|
+
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
|
|
1555
|
+
sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
|
|
1556
|
+
/**
|
|
1557
|
+
* The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
|
|
1558
|
+
*
|
|
1559
|
+
* Examples:
|
|
1560
|
+
* * 2023-12-19T16:39:57
|
|
1561
|
+
* * 2023-12-19T16:39:57-08:00
|
|
1562
|
+
*
|
|
1563
|
+
* The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
|
|
1564
|
+
*/
|
|
1509
1565
|
arriveAt?: Date | string;
|
|
1510
|
-
/**
|
|
1566
|
+
/**
|
|
1567
|
+
* The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
|
|
1568
|
+
* * Default value: now
|
|
1569
|
+
* * Other value: `dateTime`
|
|
1570
|
+
*
|
|
1571
|
+
* Examples:
|
|
1572
|
+
* * 2023-12-19T16:39:57
|
|
1573
|
+
* * 2023-12-19T16:39:57-08:00
|
|
1574
|
+
*
|
|
1575
|
+
* The `departAt` parameter cannot be used in conjunction with `arriveAt`.
|
|
1576
|
+
*/
|
|
1511
1577
|
departAt?: Date | string;
|
|
1512
1578
|
/** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
|
|
1513
1579
|
vehicleAxleWeight?: number;
|
|
@@ -1545,9 +1611,9 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryPar
|
|
|
1545
1611
|
windingness?: "low" | "normal" | "high";
|
|
1546
1612
|
/** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
|
|
1547
1613
|
hilliness?: "low" | "normal" | "high";
|
|
1548
|
-
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.
|
|
1614
|
+
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
|
|
1549
1615
|
travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
|
|
1550
|
-
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In
|
|
1616
|
+
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
|
|
1551
1617
|
avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
|
|
1552
1618
|
/**
|
|
1553
1619
|
* Possible values:
|
|
@@ -1558,7 +1624,7 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryPar
|
|
|
1558
1624
|
traffic?: boolean;
|
|
1559
1625
|
/** The type of route requested. */
|
|
1560
1626
|
routeType?: "fastest" | "shortest" | "eco" | "thrilling";
|
|
1561
|
-
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
1627
|
+
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
1562
1628
|
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
|
|
1563
1629
|
/** Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. */
|
|
1564
1630
|
vehicleEngineType?: "combustion" | "electric";
|
|
@@ -1700,9 +1766,53 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryPar
|
|
|
1700
1766
|
}
|
|
1701
1767
|
|
|
1702
1768
|
/**
|
|
1703
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1704
1769
|
*
|
|
1705
|
-
*
|
|
1770
|
+
* The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).
|
|
1771
|
+
*
|
|
1772
|
+
* For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
1773
|
+
*
|
|
1774
|
+
*
|
|
1775
|
+
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
1776
|
+
*
|
|
1777
|
+
*
|
|
1778
|
+
* The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
|
|
1779
|
+
*
|
|
1780
|
+
*
|
|
1781
|
+
*
|
|
1782
|
+
* ### Submit Synchronous Route Matrix Request
|
|
1783
|
+
* If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
|
|
1784
|
+
*
|
|
1785
|
+
* ```
|
|
1786
|
+
* GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
|
|
1787
|
+
* ```
|
|
1788
|
+
*
|
|
1789
|
+
* ### Submit Asynchronous Route Matrix Request
|
|
1790
|
+
* The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
|
|
1791
|
+
*
|
|
1792
|
+
*
|
|
1793
|
+
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
1794
|
+
*
|
|
1795
|
+
*
|
|
1796
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
1797
|
+
*
|
|
1798
|
+
*
|
|
1799
|
+
*
|
|
1800
|
+
*
|
|
1801
|
+
* ```
|
|
1802
|
+
* GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
|
|
1803
|
+
* ```
|
|
1804
|
+
*
|
|
1805
|
+
* Here's a typical sequence of asynchronous operations:
|
|
1806
|
+
* 1. Client sends a Route Matrix GET request to Azure Maps
|
|
1807
|
+
*
|
|
1808
|
+
* 2. The server will respond with one of the following:
|
|
1809
|
+
*
|
|
1810
|
+
* > HTTP `202 Accepted` - Route Matrix request has been accepted.
|
|
1811
|
+
*
|
|
1812
|
+
* > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
|
|
1813
|
+
*
|
|
1814
|
+
*
|
|
1815
|
+
* 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
|
|
1706
1816
|
*
|
|
1707
1817
|
* ```
|
|
1708
1818
|
* GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
|
|
@@ -1712,7 +1822,7 @@ export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryPar
|
|
|
1712
1822
|
* 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
|
|
1713
1823
|
*
|
|
1714
1824
|
* ### Download Sync Results
|
|
1715
|
-
* When you make a
|
|
1825
|
+
* When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
|
|
1716
1826
|
*
|
|
1717
1827
|
* ### Download Async Results
|
|
1718
1828
|
* When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:
|
|
@@ -1732,14 +1842,58 @@ export declare interface RouteGetRouteMatrix200Response extends HttpResponse {
|
|
|
1732
1842
|
}
|
|
1733
1843
|
|
|
1734
1844
|
export declare interface RouteGetRouteMatrix202Headers {
|
|
1735
|
-
/** New URL to check for the results of the long
|
|
1845
|
+
/** New URL to check for the results of the long-running operation. */
|
|
1736
1846
|
location?: string;
|
|
1737
1847
|
}
|
|
1738
1848
|
|
|
1739
1849
|
/**
|
|
1740
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1741
1850
|
*
|
|
1742
|
-
*
|
|
1851
|
+
* The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).
|
|
1852
|
+
*
|
|
1853
|
+
* For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
1854
|
+
*
|
|
1855
|
+
*
|
|
1856
|
+
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
1857
|
+
*
|
|
1858
|
+
*
|
|
1859
|
+
* The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
|
|
1860
|
+
*
|
|
1861
|
+
*
|
|
1862
|
+
*
|
|
1863
|
+
* ### Submit Synchronous Route Matrix Request
|
|
1864
|
+
* If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
|
|
1865
|
+
*
|
|
1866
|
+
* ```
|
|
1867
|
+
* GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
|
|
1868
|
+
* ```
|
|
1869
|
+
*
|
|
1870
|
+
* ### Submit Asynchronous Route Matrix Request
|
|
1871
|
+
* The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
|
|
1872
|
+
*
|
|
1873
|
+
*
|
|
1874
|
+
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
1875
|
+
*
|
|
1876
|
+
*
|
|
1877
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
1878
|
+
*
|
|
1879
|
+
*
|
|
1880
|
+
*
|
|
1881
|
+
*
|
|
1882
|
+
* ```
|
|
1883
|
+
* GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
|
|
1884
|
+
* ```
|
|
1885
|
+
*
|
|
1886
|
+
* Here's a typical sequence of asynchronous operations:
|
|
1887
|
+
* 1. Client sends a Route Matrix GET request to Azure Maps
|
|
1888
|
+
*
|
|
1889
|
+
* 2. The server will respond with one of the following:
|
|
1890
|
+
*
|
|
1891
|
+
* > HTTP `202 Accepted` - Route Matrix request has been accepted.
|
|
1892
|
+
*
|
|
1893
|
+
* > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
|
|
1894
|
+
*
|
|
1895
|
+
*
|
|
1896
|
+
* 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
|
|
1743
1897
|
*
|
|
1744
1898
|
* ```
|
|
1745
1899
|
* GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
|
|
@@ -1749,7 +1903,7 @@ export declare interface RouteGetRouteMatrix202Headers {
|
|
|
1749
1903
|
* 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
|
|
1750
1904
|
*
|
|
1751
1905
|
* ### Download Sync Results
|
|
1752
|
-
* When you make a
|
|
1906
|
+
* When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
|
|
1753
1907
|
*
|
|
1754
1908
|
* ### Download Async Results
|
|
1755
1909
|
* When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:
|
|
@@ -1765,21 +1919,16 @@ export declare interface RouteGetRouteMatrix202Headers {
|
|
|
1765
1919
|
*/
|
|
1766
1920
|
export declare interface RouteGetRouteMatrix202Response extends HttpResponse {
|
|
1767
1921
|
status: "202";
|
|
1768
|
-
body: Record<string, unknown>;
|
|
1769
1922
|
headers: RawHttpHeaders & RouteGetRouteMatrix202Headers;
|
|
1770
1923
|
}
|
|
1771
1924
|
|
|
1772
1925
|
export declare type RouteGetRouteMatrixParameters = RequestParameters;
|
|
1773
1926
|
|
|
1774
1927
|
/**
|
|
1775
|
-
* __Route Range (Isochrone) API__
|
|
1776
|
-
*
|
|
1777
1928
|
*
|
|
1778
|
-
*
|
|
1929
|
+
* The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.
|
|
1779
1930
|
*
|
|
1780
|
-
*
|
|
1781
|
-
*
|
|
1782
|
-
* The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.
|
|
1931
|
+
* The returned polygon can be used for further processing such as [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to search for POIs within the provided isochrone.
|
|
1783
1932
|
*/
|
|
1784
1933
|
export declare interface RouteGetRouteRange200Response extends HttpResponse {
|
|
1785
1934
|
status: "200";
|
|
@@ -1787,14 +1936,10 @@ export declare interface RouteGetRouteRange200Response extends HttpResponse {
|
|
|
1787
1936
|
}
|
|
1788
1937
|
|
|
1789
1938
|
/**
|
|
1790
|
-
* __Route Range (Isochrone) API__
|
|
1791
|
-
*
|
|
1792
1939
|
*
|
|
1793
|
-
*
|
|
1940
|
+
* The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.
|
|
1794
1941
|
*
|
|
1795
|
-
*
|
|
1796
|
-
*
|
|
1797
|
-
* The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.
|
|
1942
|
+
* The returned polygon can be used for further processing such as [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to search for POIs within the provided isochrone.
|
|
1798
1943
|
*/
|
|
1799
1944
|
export declare interface RouteGetRouteRangeDefaultResponse extends HttpResponse {
|
|
1800
1945
|
status: string;
|
|
@@ -1818,7 +1963,17 @@ export declare interface RouteGetRouteRangeQueryParamProperties {
|
|
|
1818
1963
|
timeBudgetInSec?: number;
|
|
1819
1964
|
/** Distance budget in meters that determines maximal range which can be travelled using driving distance. The Consumption Model will only affect the range when routeType is eco.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. */
|
|
1820
1965
|
distanceBudgetInMeters?: number;
|
|
1821
|
-
/**
|
|
1966
|
+
/**
|
|
1967
|
+
* The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
|
|
1968
|
+
* * Default value: now
|
|
1969
|
+
* * Other value: `dateTime`
|
|
1970
|
+
*
|
|
1971
|
+
* Examples:
|
|
1972
|
+
* * 2023-12-19T16:39:57
|
|
1973
|
+
* * 2023-12-19T16:39:57-08:00
|
|
1974
|
+
*
|
|
1975
|
+
* The `departAt` parameter cannot be used in conjunction with `arriveAt`.
|
|
1976
|
+
*/
|
|
1822
1977
|
departAt?: Date | string;
|
|
1823
1978
|
/** The type of route requested. */
|
|
1824
1979
|
routeType?: "fastest" | "shortest" | "eco" | "thrilling";
|
|
@@ -1829,9 +1984,9 @@ export declare interface RouteGetRouteRangeQueryParamProperties {
|
|
|
1829
1984
|
* during routing, the effect of historic traffic on effective road speeds is still incorporated.
|
|
1830
1985
|
*/
|
|
1831
1986
|
traffic?: boolean;
|
|
1832
|
-
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In
|
|
1987
|
+
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
|
|
1833
1988
|
avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
|
|
1834
|
-
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.
|
|
1989
|
+
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
|
|
1835
1990
|
travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
|
|
1836
1991
|
/** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
|
|
1837
1992
|
hilliness?: "low" | "normal" | "high";
|
|
@@ -1869,7 +2024,7 @@ export declare interface RouteGetRouteRangeQueryParamProperties {
|
|
|
1869
2024
|
vehicleWeight?: number;
|
|
1870
2025
|
/** Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. */
|
|
1871
2026
|
vehicleCommercial?: boolean;
|
|
1872
|
-
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
2027
|
+
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
1873
2028
|
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
|
|
1874
2029
|
/** Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. */
|
|
1875
2030
|
vehicleEngineType?: "combustion" | "electric";
|
|
@@ -2013,49 +2168,49 @@ export declare interface RouteGetRouteRangeQueryParamProperties {
|
|
|
2013
2168
|
/** Contains guidance related elements. This field is present only when guidance was requested and is available. */
|
|
2014
2169
|
export declare interface RouteGuidanceOutput {
|
|
2015
2170
|
/** A list of instructions describing maneuvers. */
|
|
2016
|
-
instructions: Array<RouteInstructionOutput>;
|
|
2171
|
+
readonly instructions: Array<RouteInstructionOutput>;
|
|
2017
2172
|
/** Groups a sequence of instruction elements which are related to each other. */
|
|
2018
|
-
instructionGroups: Array<RouteInstructionGroupOutput>;
|
|
2173
|
+
readonly instructionGroups: Array<RouteInstructionGroupOutput>;
|
|
2019
2174
|
}
|
|
2020
2175
|
|
|
2021
2176
|
/** Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available. */
|
|
2022
2177
|
export declare interface RouteInstructionGroupOutput {
|
|
2023
2178
|
/** Index of the first instruction in the instructions and belonging to this group. */
|
|
2024
|
-
firstInstructionIndex?: number;
|
|
2179
|
+
readonly firstInstructionIndex?: number;
|
|
2025
2180
|
/** Index of the last instruction in the instructions and belonging to this group. */
|
|
2026
|
-
lastInstructionIndex?: number;
|
|
2181
|
+
readonly lastInstructionIndex?: number;
|
|
2027
2182
|
/** Length of the group. */
|
|
2028
|
-
groupLengthInMeters?: number;
|
|
2183
|
+
readonly groupLengthInMeters?: number;
|
|
2029
2184
|
/** Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged). */
|
|
2030
|
-
groupMessage?: string;
|
|
2185
|
+
readonly groupMessage?: string;
|
|
2031
2186
|
}
|
|
2032
2187
|
|
|
2033
2188
|
/** A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'. */
|
|
2034
2189
|
export declare interface RouteInstructionOutput {
|
|
2035
2190
|
/** Distance from the start of the route to the point of the instruction. */
|
|
2036
|
-
routeOffsetInMeters?: number;
|
|
2191
|
+
readonly routeOffsetInMeters?: number;
|
|
2037
2192
|
/** Estimated travel time up to the point corresponding to routeOffsetInMeters. */
|
|
2038
|
-
travelTimeInSeconds?: number;
|
|
2193
|
+
readonly travelTimeInSeconds?: number;
|
|
2039
2194
|
/** A location represented as a latitude and longitude. */
|
|
2040
2195
|
point?: LatLongPairOutput;
|
|
2041
2196
|
/** The index of the point in the list of polyline "points" corresponding to the point of the instruction. */
|
|
2042
|
-
pointIndex?: number;
|
|
2197
|
+
readonly pointIndex?: number;
|
|
2043
2198
|
/** Type of the instruction, e.g., turn or change of road form. */
|
|
2044
2199
|
instructionType?: "TURN" | "ROAD_CHANGE" | "LOCATION_DEPARTURE" | "LOCATION_ARRIVAL" | "DIRECTION_INFO" | "LOCATION_WAYPOINT";
|
|
2045
2200
|
/** The road number(s) of the next significant road segment(s) after the maneuver, or of the road(s) to be followed. Example: ["E34", "N205"] */
|
|
2046
|
-
roadNumbers?: Array<string>;
|
|
2201
|
+
readonly roadNumbers?: Array<string>;
|
|
2047
2202
|
/** The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by "," and possibly aggregated by "-", e.g., "10, 13-15". */
|
|
2048
|
-
exitNumber?: string;
|
|
2203
|
+
readonly exitNumber?: string;
|
|
2049
2204
|
/** Street name of the next significant road segment after the maneuver, or of the street that should be followed. */
|
|
2050
|
-
street?: string;
|
|
2205
|
+
readonly street?: string;
|
|
2051
2206
|
/** The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed. */
|
|
2052
|
-
signpostText?: string;
|
|
2207
|
+
readonly signpostText?: string;
|
|
2053
2208
|
/** 3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA. */
|
|
2054
|
-
countryCode?: string;
|
|
2055
|
-
/** A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries like the US, Canada, and Mexico. */
|
|
2056
|
-
stateCode?: string;
|
|
2209
|
+
readonly countryCode?: string;
|
|
2210
|
+
/** A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries/regions like the US, Canada, and Mexico. */
|
|
2211
|
+
readonly stateCode?: string;
|
|
2057
2212
|
/** The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout. */
|
|
2058
|
-
junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION";
|
|
2213
|
+
readonly junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION";
|
|
2059
2214
|
/**
|
|
2060
2215
|
* Indicates the direction of an instruction. If junctionType indicates a turn instruction:
|
|
2061
2216
|
*
|
|
@@ -2069,17 +2224,17 @@ export declare interface RouteInstructionOutput {
|
|
|
2069
2224
|
* * <0 - keep left
|
|
2070
2225
|
* * \>0 - keep right
|
|
2071
2226
|
*/
|
|
2072
|
-
turnAngleInDecimalDegrees?: number;
|
|
2227
|
+
readonly turnAngleInDecimalDegrees?: number;
|
|
2073
2228
|
/** This indicates which exit to take at a roundabout. */
|
|
2074
|
-
roundaboutExitNumber?:
|
|
2229
|
+
readonly roundaboutExitNumber?: number;
|
|
2075
2230
|
/** It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right". */
|
|
2076
|
-
possibleCombineWithNext?: boolean;
|
|
2231
|
+
readonly possibleCombineWithNext?: boolean;
|
|
2077
2232
|
/** Indicates left-hand vs. right-hand side driving at the point of the maneuver. */
|
|
2078
|
-
drivingSide?: "LEFT" | "RIGHT";
|
|
2233
|
+
readonly drivingSide?: "LEFT" | "RIGHT";
|
|
2079
2234
|
/** A code identifying the maneuver. */
|
|
2080
|
-
maneuver?: "ARRIVE" | "ARRIVE_LEFT" | "ARRIVE_RIGHT" | "DEPART" | "STRAIGHT" | "KEEP_RIGHT" | "BEAR_RIGHT" | "TURN_RIGHT" | "SHARP_RIGHT" | "KEEP_LEFT" | "BEAR_LEFT" | "TURN_LEFT" | "SHARP_LEFT" | "MAKE_UTURN" | "ENTER_MOTORWAY" | "ENTER_FREEWAY" | "ENTER_HIGHWAY" | "TAKE_EXIT" | "MOTORWAY_EXIT_LEFT" | "MOTORWAY_EXIT_RIGHT" | "TAKE_FERRY" | "ROUNDABOUT_CROSS" | "ROUNDABOUT_RIGHT" | "ROUNDABOUT_LEFT" | "ROUNDABOUT_BACK" | "TRY_MAKE_UTURN" | "FOLLOW" | "SWITCH_PARALLEL_ROAD" | "SWITCH_MAIN_ROAD" | "ENTRANCE_RAMP" | "WAYPOINT_LEFT" | "WAYPOINT_RIGHT" | "WAYPOINT_REACHED";
|
|
2235
|
+
readonly maneuver?: "ARRIVE" | "ARRIVE_LEFT" | "ARRIVE_RIGHT" | "DEPART" | "STRAIGHT" | "KEEP_RIGHT" | "BEAR_RIGHT" | "TURN_RIGHT" | "SHARP_RIGHT" | "KEEP_LEFT" | "BEAR_LEFT" | "TURN_LEFT" | "SHARP_LEFT" | "MAKE_UTURN" | "ENTER_MOTORWAY" | "ENTER_FREEWAY" | "ENTER_HIGHWAY" | "TAKE_EXIT" | "MOTORWAY_EXIT_LEFT" | "MOTORWAY_EXIT_RIGHT" | "TAKE_FERRY" | "ROUNDABOUT_CROSS" | "ROUNDABOUT_RIGHT" | "ROUNDABOUT_LEFT" | "ROUNDABOUT_BACK" | "TRY_MAKE_UTURN" | "FOLLOW" | "SWITCH_PARALLEL_ROAD" | "SWITCH_MAIN_ROAD" | "ENTRANCE_RAMP" | "WAYPOINT_LEFT" | "WAYPOINT_RIGHT" | "WAYPOINT_REACHED";
|
|
2081
2236
|
/** A human-readable message for the maneuver. */
|
|
2082
|
-
message?: string;
|
|
2237
|
+
readonly message?: string;
|
|
2083
2238
|
/**
|
|
2084
2239
|
* A human-readable message for the maneuver combined with the message from the next instruction. Sometimes it is possible to combine two successive instructions into a single instruction making it easier to follow. When this is the case the possibleCombineWithNext flag will be true. For example:
|
|
2085
2240
|
*
|
|
@@ -2095,23 +2250,23 @@ export declare interface RouteInstructionOutput {
|
|
|
2095
2250
|
* then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
|
|
2096
2251
|
* ```
|
|
2097
2252
|
*/
|
|
2098
|
-
combinedMessage?: string;
|
|
2253
|
+
readonly combinedMessage?: string;
|
|
2099
2254
|
}
|
|
2100
2255
|
|
|
2101
2256
|
/** A description of a part of a route, comprised of a list of points. Each additional waypoint provided in the request will result in an additional leg in the returned route. */
|
|
2102
2257
|
export declare interface RouteLegOutput {
|
|
2103
2258
|
/** Summary object */
|
|
2104
|
-
summary: RouteSummaryOutput;
|
|
2259
|
+
readonly summary: RouteSummaryOutput;
|
|
2105
2260
|
/** Points array */
|
|
2106
|
-
points: Array<LatLongPairOutput>;
|
|
2261
|
+
readonly points: Array<LatLongPairOutput>;
|
|
2107
2262
|
}
|
|
2108
2263
|
|
|
2109
2264
|
/** Matrix result object */
|
|
2110
2265
|
export declare interface RouteMatrixOutput {
|
|
2111
2266
|
/** StatusCode property for the current cell in the input matrix. */
|
|
2112
|
-
statusCode: number;
|
|
2267
|
+
readonly statusCode: number;
|
|
2113
2268
|
/** Response object of the current cell in the input matrix. */
|
|
2114
|
-
response?: RouteMatrixResultResponseOutput;
|
|
2269
|
+
readonly response?: RouteMatrixResultResponseOutput;
|
|
2115
2270
|
}
|
|
2116
2271
|
|
|
2117
2272
|
/** An object with a matrix of coordinates. */
|
|
@@ -2125,44 +2280,44 @@ export declare interface RouteMatrixQuery {
|
|
|
2125
2280
|
/** This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query. */
|
|
2126
2281
|
export declare interface RouteMatrixResultOutput {
|
|
2127
2282
|
/** Format Version property */
|
|
2128
|
-
formatVersion?: string;
|
|
2283
|
+
readonly formatVersion?: string;
|
|
2129
2284
|
/** Results as a 2 dimensional array of route summaries. */
|
|
2130
|
-
matrix: Array<Array<RouteMatrixOutput>>;
|
|
2285
|
+
readonly matrix: Array<Array<RouteMatrixOutput>>;
|
|
2131
2286
|
/** Summary object */
|
|
2132
|
-
summary: RouteMatrixSummaryOutput;
|
|
2287
|
+
readonly summary: RouteMatrixSummaryOutput;
|
|
2133
2288
|
}
|
|
2134
2289
|
|
|
2135
2290
|
/** Response object of the current cell in the input matrix. */
|
|
2136
2291
|
export declare interface RouteMatrixResultResponseOutput {
|
|
2137
2292
|
/** Summary object */
|
|
2138
|
-
routeSummary?: RouteSummaryOutput;
|
|
2293
|
+
readonly routeSummary?: RouteSummaryOutput;
|
|
2139
2294
|
}
|
|
2140
2295
|
|
|
2141
2296
|
/** Summary object */
|
|
2142
2297
|
export declare interface RouteMatrixSummaryOutput {
|
|
2143
2298
|
/** Number of successful routes in the response. */
|
|
2144
|
-
successfulRoutes: number;
|
|
2299
|
+
readonly successfulRoutes: number;
|
|
2145
2300
|
/** Total number of routes requested. Number of cells in the input matrix. */
|
|
2146
|
-
totalRoutes: number;
|
|
2301
|
+
readonly totalRoutes: number;
|
|
2147
2302
|
}
|
|
2148
2303
|
|
|
2149
2304
|
/** Optimized way point object. */
|
|
2150
2305
|
export declare interface RouteOptimizedWaypointOutput {
|
|
2151
2306
|
/** Way point index provided by the user. */
|
|
2152
|
-
providedIndex: number;
|
|
2307
|
+
readonly providedIndex: number;
|
|
2153
2308
|
/** Optimized way point index from the system. */
|
|
2154
|
-
optimizedIndex: number;
|
|
2309
|
+
readonly optimizedIndex: number;
|
|
2155
2310
|
}
|
|
2156
2311
|
|
|
2157
2312
|
export declare interface RouteOutput {
|
|
2158
2313
|
/** Summary object */
|
|
2159
|
-
summary: RouteSummaryOutput;
|
|
2314
|
+
readonly summary: RouteSummaryOutput;
|
|
2160
2315
|
/** Legs array */
|
|
2161
|
-
legs: Array<RouteLegOutput>;
|
|
2316
|
+
readonly legs: Array<RouteLegOutput>;
|
|
2162
2317
|
/** Sections array */
|
|
2163
|
-
sections?: Array<RouteSectionOutput>;
|
|
2318
|
+
readonly sections?: Array<RouteSectionOutput>;
|
|
2164
2319
|
/** Contains guidance related elements. This field is present only when guidance was requested and is available. */
|
|
2165
|
-
guidance?: RouteGuidanceOutput;
|
|
2320
|
+
readonly guidance?: RouteGuidanceOutput;
|
|
2166
2321
|
}
|
|
2167
2322
|
|
|
2168
2323
|
/** Reachable Range */
|
|
@@ -2170,13 +2325,13 @@ export declare interface RouteRangeOutput {
|
|
|
2170
2325
|
/** Center point of the reachable range */
|
|
2171
2326
|
center: LatLongPairOutput;
|
|
2172
2327
|
/** Polygon boundary of the reachable range represented as a list of points. */
|
|
2173
|
-
boundary: Array<LatLongPairOutput>;
|
|
2328
|
+
readonly boundary: Array<LatLongPairOutput>;
|
|
2174
2329
|
}
|
|
2175
2330
|
|
|
2176
2331
|
/** This object is returned from a successful Route Reachable Range call */
|
|
2177
2332
|
export declare interface RouteRangeResultOutput {
|
|
2178
2333
|
/** Format Version property */
|
|
2179
|
-
formatVersion?: string;
|
|
2334
|
+
readonly formatVersion?: string;
|
|
2180
2335
|
/** Reachable Range */
|
|
2181
2336
|
reachableRange: RouteRangeOutput;
|
|
2182
2337
|
/** Reports the effective settings used in the current call. */
|
|
@@ -2186,18 +2341,13 @@ export declare interface RouteRangeResultOutput {
|
|
|
2186
2341
|
/** Reports the effective settings used in the current call. */
|
|
2187
2342
|
export declare interface RouteReportOutput {
|
|
2188
2343
|
/** Effective parameters or data used when calling this Route API. */
|
|
2189
|
-
effectiveSettings: Array<EffectiveSettingOutput>;
|
|
2344
|
+
readonly effectiveSettings: Array<EffectiveSettingOutput>;
|
|
2190
2345
|
}
|
|
2191
2346
|
|
|
2192
2347
|
/**
|
|
2193
|
-
* **Route Directions Batch API**
|
|
2194
|
-
*
|
|
2195
|
-
*
|
|
2196
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
2197
|
-
*
|
|
2198
2348
|
*
|
|
2349
|
+
* The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).
|
|
2199
2350
|
*
|
|
2200
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
2201
2351
|
* ### Submit Asynchronous Batch Request
|
|
2202
2352
|
* The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
|
|
2203
2353
|
* - It allows the retrieval of results in a separate call (multiple downloads are possible).
|
|
@@ -2205,10 +2355,13 @@ export declare interface RouteReportOutput {
|
|
|
2205
2355
|
* - The number of batch items is limited to **700** for this API.
|
|
2206
2356
|
*
|
|
2207
2357
|
* When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.
|
|
2208
|
-
* The asynchronous responses are stored for **
|
|
2358
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
2209
2359
|
*
|
|
2210
|
-
* Please note that asynchronous batch request is a long-running
|
|
2211
|
-
* 1. Client sends a Route Directions Batch `POST` request to Azure Maps
|
|
2360
|
+
* Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
|
|
2361
|
+
* 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
|
|
2362
|
+
* ```
|
|
2363
|
+
* POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
|
|
2364
|
+
* ```
|
|
2212
2365
|
* 2. The server will respond with one of the following:
|
|
2213
2366
|
*
|
|
2214
2367
|
* > HTTP `202 Accepted` - Batch request has been accepted.
|
|
@@ -2217,9 +2370,9 @@ export declare interface RouteReportOutput {
|
|
|
2217
2370
|
*
|
|
2218
2371
|
* 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.
|
|
2219
2372
|
* This status URI looks like following:
|
|
2220
|
-
*
|
|
2221
|
-
*
|
|
2222
|
-
*
|
|
2373
|
+
* ```
|
|
2374
|
+
* GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
|
|
2375
|
+
* ```
|
|
2223
2376
|
* 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
|
|
2224
2377
|
*
|
|
2225
2378
|
* ### POST Body for Batch Request
|
|
@@ -2346,19 +2499,14 @@ export declare interface RouteRequestRouteDirectionsBatch200Response extends Htt
|
|
|
2346
2499
|
}
|
|
2347
2500
|
|
|
2348
2501
|
export declare interface RouteRequestRouteDirectionsBatch202Headers {
|
|
2349
|
-
/** New URL to check for the results of the long
|
|
2502
|
+
/** New URL to check for the results of the long-running operation. */
|
|
2350
2503
|
location?: string;
|
|
2351
2504
|
}
|
|
2352
2505
|
|
|
2353
2506
|
/**
|
|
2354
|
-
* **Route Directions Batch API**
|
|
2355
|
-
*
|
|
2356
|
-
*
|
|
2357
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
2358
|
-
*
|
|
2359
2507
|
*
|
|
2508
|
+
* The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).
|
|
2360
2509
|
*
|
|
2361
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
2362
2510
|
* ### Submit Asynchronous Batch Request
|
|
2363
2511
|
* The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
|
|
2364
2512
|
* - It allows the retrieval of results in a separate call (multiple downloads are possible).
|
|
@@ -2366,10 +2514,13 @@ export declare interface RouteRequestRouteDirectionsBatch202Headers {
|
|
|
2366
2514
|
* - The number of batch items is limited to **700** for this API.
|
|
2367
2515
|
*
|
|
2368
2516
|
* When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.
|
|
2369
|
-
* The asynchronous responses are stored for **
|
|
2517
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
2370
2518
|
*
|
|
2371
|
-
* Please note that asynchronous batch request is a long-running
|
|
2372
|
-
* 1. Client sends a Route Directions Batch `POST` request to Azure Maps
|
|
2519
|
+
* Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
|
|
2520
|
+
* 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
|
|
2521
|
+
* ```
|
|
2522
|
+
* POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
|
|
2523
|
+
* ```
|
|
2373
2524
|
* 2. The server will respond with one of the following:
|
|
2374
2525
|
*
|
|
2375
2526
|
* > HTTP `202 Accepted` - Batch request has been accepted.
|
|
@@ -2378,9 +2529,9 @@ export declare interface RouteRequestRouteDirectionsBatch202Headers {
|
|
|
2378
2529
|
*
|
|
2379
2530
|
* 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.
|
|
2380
2531
|
* This status URI looks like following:
|
|
2381
|
-
*
|
|
2382
|
-
*
|
|
2383
|
-
*
|
|
2532
|
+
* ```
|
|
2533
|
+
* GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
|
|
2534
|
+
* ```
|
|
2384
2535
|
* 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
|
|
2385
2536
|
*
|
|
2386
2537
|
* ### POST Body for Batch Request
|
|
@@ -2503,7 +2654,6 @@ export declare interface RouteRequestRouteDirectionsBatch202Headers {
|
|
|
2503
2654
|
*/
|
|
2504
2655
|
export declare interface RouteRequestRouteDirectionsBatch202Response extends HttpResponse {
|
|
2505
2656
|
status: "202";
|
|
2506
|
-
body: Record<string, unknown>;
|
|
2507
2657
|
headers: RawHttpHeaders & RouteRequestRouteDirectionsBatch202Headers;
|
|
2508
2658
|
}
|
|
2509
2659
|
|
|
@@ -2520,14 +2670,8 @@ export declare interface RouteRequestRouteDirectionsBatchMediaTypesParam {
|
|
|
2520
2670
|
export declare type RouteRequestRouteDirectionsBatchParameters = RouteRequestRouteDirectionsBatchMediaTypesParam & RouteRequestRouteDirectionsBatchBodyParam & RequestParameters;
|
|
2521
2671
|
|
|
2522
2672
|
/**
|
|
2523
|
-
* **Route Directions Batch API**
|
|
2524
|
-
*
|
|
2525
|
-
*
|
|
2526
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
2527
|
-
*
|
|
2528
2673
|
*
|
|
2529
|
-
*
|
|
2530
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
2674
|
+
* The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
|
|
2531
2675
|
* ### Submit Synchronous Batch Request
|
|
2532
2676
|
* The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
|
|
2533
2677
|
* ```
|
|
@@ -2621,14 +2765,8 @@ export declare interface RouteRequestRouteDirectionsBatchSync200Response extends
|
|
|
2621
2765
|
}
|
|
2622
2766
|
|
|
2623
2767
|
/**
|
|
2624
|
-
* **Route Directions Batch API**
|
|
2625
|
-
*
|
|
2626
|
-
*
|
|
2627
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
2628
|
-
*
|
|
2629
2768
|
*
|
|
2630
|
-
*
|
|
2631
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
2769
|
+
* The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
|
|
2632
2770
|
* ### Submit Synchronous Batch Request
|
|
2633
2771
|
* The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
|
|
2634
2772
|
* ```
|
|
@@ -2727,14 +2865,8 @@ export declare interface RouteRequestRouteDirectionsBatchSyncBodyParam {
|
|
|
2727
2865
|
}
|
|
2728
2866
|
|
|
2729
2867
|
/**
|
|
2730
|
-
* **Route Directions Batch API**
|
|
2731
|
-
*
|
|
2732
|
-
*
|
|
2733
|
-
* **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
2734
|
-
*
|
|
2735
2868
|
*
|
|
2736
|
-
*
|
|
2737
|
-
* The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
|
|
2869
|
+
* The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
|
|
2738
2870
|
* ### Submit Synchronous Batch Request
|
|
2739
2871
|
* The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
|
|
2740
2872
|
* ```
|
|
@@ -2836,9 +2968,7 @@ export declare type RouteRequestRouteDirectionsBatchSyncParameters = RouteReques
|
|
|
2836
2968
|
|
|
2837
2969
|
/**
|
|
2838
2970
|
*
|
|
2839
|
-
*
|
|
2840
|
-
*
|
|
2841
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
2971
|
+
* The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
2842
2972
|
*
|
|
2843
2973
|
*
|
|
2844
2974
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -2846,6 +2976,9 @@ export declare type RouteRequestRouteDirectionsBatchSyncParameters = RouteReques
|
|
|
2846
2976
|
*
|
|
2847
2977
|
* The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
|
|
2848
2978
|
*
|
|
2979
|
+
* > [!NOTE]
|
|
2980
|
+
* > All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
|
|
2981
|
+
*
|
|
2849
2982
|
*
|
|
2850
2983
|
*
|
|
2851
2984
|
* ### Submit Synchronous Route Matrix Request
|
|
@@ -2862,7 +2995,7 @@ export declare type RouteRequestRouteDirectionsBatchSyncParameters = RouteReques
|
|
|
2862
2995
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
2863
2996
|
*
|
|
2864
2997
|
*
|
|
2865
|
-
* The asynchronous responses are stored for **
|
|
2998
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
2866
2999
|
*
|
|
2867
3000
|
*
|
|
2868
3001
|
*
|
|
@@ -2911,15 +3044,13 @@ export declare interface RouteRequestRouteMatrix200Response extends HttpResponse
|
|
|
2911
3044
|
}
|
|
2912
3045
|
|
|
2913
3046
|
export declare interface RouteRequestRouteMatrix202Headers {
|
|
2914
|
-
/** New URL to check for the results of the long
|
|
3047
|
+
/** New URL to check for the results of the long-running operation. */
|
|
2915
3048
|
location?: string;
|
|
2916
3049
|
}
|
|
2917
3050
|
|
|
2918
3051
|
/**
|
|
2919
3052
|
*
|
|
2920
|
-
*
|
|
2921
|
-
*
|
|
2922
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3053
|
+
* The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
2923
3054
|
*
|
|
2924
3055
|
*
|
|
2925
3056
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -2927,6 +3058,9 @@ export declare interface RouteRequestRouteMatrix202Headers {
|
|
|
2927
3058
|
*
|
|
2928
3059
|
* The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
|
|
2929
3060
|
*
|
|
3061
|
+
* > [!NOTE]
|
|
3062
|
+
* > All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
|
|
3063
|
+
*
|
|
2930
3064
|
*
|
|
2931
3065
|
*
|
|
2932
3066
|
* ### Submit Synchronous Route Matrix Request
|
|
@@ -2943,7 +3077,7 @@ export declare interface RouteRequestRouteMatrix202Headers {
|
|
|
2943
3077
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
2944
3078
|
*
|
|
2945
3079
|
*
|
|
2946
|
-
* The asynchronous responses are stored for **
|
|
3080
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
2947
3081
|
*
|
|
2948
3082
|
*
|
|
2949
3083
|
*
|
|
@@ -2988,7 +3122,6 @@ export declare interface RouteRequestRouteMatrix202Headers {
|
|
|
2988
3122
|
*/
|
|
2989
3123
|
export declare interface RouteRequestRouteMatrix202Response extends HttpResponse {
|
|
2990
3124
|
status: "202";
|
|
2991
|
-
body: Record<string, unknown>;
|
|
2992
3125
|
headers: RawHttpHeaders & RouteRequestRouteMatrix202Headers;
|
|
2993
3126
|
}
|
|
2994
3127
|
|
|
@@ -3013,11 +3146,29 @@ export declare interface RouteRequestRouteMatrixQueryParamProperties {
|
|
|
3013
3146
|
waitForResults?: boolean;
|
|
3014
3147
|
/** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
|
|
3015
3148
|
computeTravelTimeFor?: "none" | "all";
|
|
3016
|
-
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned.
|
|
3017
|
-
sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"
|
|
3018
|
-
/**
|
|
3149
|
+
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
|
|
3150
|
+
sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
|
|
3151
|
+
/**
|
|
3152
|
+
* The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
|
|
3153
|
+
*
|
|
3154
|
+
* Examples:
|
|
3155
|
+
* * 2023-12-19T16:39:57
|
|
3156
|
+
* * 2023-12-19T16:39:57-08:00
|
|
3157
|
+
*
|
|
3158
|
+
* The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
|
|
3159
|
+
*/
|
|
3019
3160
|
arriveAt?: Date | string;
|
|
3020
|
-
/**
|
|
3161
|
+
/**
|
|
3162
|
+
* The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
|
|
3163
|
+
* * Default value: now
|
|
3164
|
+
* * Other value: `dateTime`
|
|
3165
|
+
*
|
|
3166
|
+
* Examples:
|
|
3167
|
+
* * 2023-12-19T16:39:57
|
|
3168
|
+
* * 2023-12-19T16:39:57-08:00
|
|
3169
|
+
*
|
|
3170
|
+
* The `departAt` parameter cannot be used in conjunction with `arriveAt`.
|
|
3171
|
+
*/
|
|
3021
3172
|
departAt?: Date | string;
|
|
3022
3173
|
/** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
|
|
3023
3174
|
vehicleAxleWeight?: number;
|
|
@@ -3041,9 +3192,9 @@ export declare interface RouteRequestRouteMatrixQueryParamProperties {
|
|
|
3041
3192
|
windingness?: "low" | "normal" | "high";
|
|
3042
3193
|
/** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
|
|
3043
3194
|
hilliness?: "low" | "normal" | "high";
|
|
3044
|
-
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.
|
|
3195
|
+
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
|
|
3045
3196
|
travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
|
|
3046
|
-
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In
|
|
3197
|
+
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
|
|
3047
3198
|
avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
|
|
3048
3199
|
/**
|
|
3049
3200
|
* Possible values:
|
|
@@ -3054,15 +3205,13 @@ export declare interface RouteRequestRouteMatrixQueryParamProperties {
|
|
|
3054
3205
|
traffic?: boolean;
|
|
3055
3206
|
/** The type of route requested. */
|
|
3056
3207
|
routeType?: "fastest" | "shortest" | "eco" | "thrilling";
|
|
3057
|
-
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
3208
|
+
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
3058
3209
|
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
|
|
3059
3210
|
}
|
|
3060
3211
|
|
|
3061
3212
|
/**
|
|
3062
3213
|
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3065
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3214
|
+
* The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3066
3215
|
*
|
|
3067
3216
|
*
|
|
3068
3217
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -3086,7 +3235,7 @@ export declare interface RouteRequestRouteMatrixQueryParamProperties {
|
|
|
3086
3235
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
3087
3236
|
*
|
|
3088
3237
|
*
|
|
3089
|
-
* The asynchronous responses are stored for **
|
|
3238
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
3090
3239
|
*
|
|
3091
3240
|
*
|
|
3092
3241
|
*
|
|
@@ -3136,9 +3285,7 @@ export declare interface RouteRequestRouteMatrixSync200Response extends HttpResp
|
|
|
3136
3285
|
|
|
3137
3286
|
/**
|
|
3138
3287
|
*
|
|
3139
|
-
*
|
|
3140
|
-
*
|
|
3141
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3288
|
+
* The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3142
3289
|
*
|
|
3143
3290
|
*
|
|
3144
3291
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -3162,7 +3309,7 @@ export declare interface RouteRequestRouteMatrixSync200Response extends HttpResp
|
|
|
3162
3309
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
3163
3310
|
*
|
|
3164
3311
|
*
|
|
3165
|
-
* The asynchronous responses are stored for **
|
|
3312
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
3166
3313
|
*
|
|
3167
3314
|
*
|
|
3168
3315
|
*
|
|
@@ -3217,9 +3364,7 @@ export declare interface RouteRequestRouteMatrixSyncBodyParam {
|
|
|
3217
3364
|
|
|
3218
3365
|
/**
|
|
3219
3366
|
*
|
|
3220
|
-
*
|
|
3221
|
-
*
|
|
3222
|
-
* The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3367
|
+
* The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
|
|
3223
3368
|
*
|
|
3224
3369
|
*
|
|
3225
3370
|
* For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
|
|
@@ -3243,7 +3388,7 @@ export declare interface RouteRequestRouteMatrixSyncBodyParam {
|
|
|
3243
3388
|
* The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
|
|
3244
3389
|
*
|
|
3245
3390
|
*
|
|
3246
|
-
* The asynchronous responses are stored for **
|
|
3391
|
+
* The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
|
|
3247
3392
|
*
|
|
3248
3393
|
*
|
|
3249
3394
|
*
|
|
@@ -3307,11 +3452,29 @@ export declare interface RouteRequestRouteMatrixSyncQueryParamProperties {
|
|
|
3307
3452
|
waitForResults?: boolean;
|
|
3308
3453
|
/** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
|
|
3309
3454
|
computeTravelTimeFor?: "none" | "all";
|
|
3310
|
-
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned.
|
|
3311
|
-
sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"
|
|
3312
|
-
/**
|
|
3455
|
+
/** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
|
|
3456
|
+
sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
|
|
3457
|
+
/**
|
|
3458
|
+
* The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
|
|
3459
|
+
*
|
|
3460
|
+
* Examples:
|
|
3461
|
+
* * 2023-12-19T16:39:57
|
|
3462
|
+
* * 2023-12-19T16:39:57-08:00
|
|
3463
|
+
*
|
|
3464
|
+
* The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
|
|
3465
|
+
*/
|
|
3313
3466
|
arriveAt?: Date | string;
|
|
3314
|
-
/**
|
|
3467
|
+
/**
|
|
3468
|
+
* The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
|
|
3469
|
+
* * Default value: now
|
|
3470
|
+
* * Other value: `dateTime`
|
|
3471
|
+
*
|
|
3472
|
+
* Examples:
|
|
3473
|
+
* * 2023-12-19T16:39:57
|
|
3474
|
+
* * 2023-12-19T16:39:57-08:00
|
|
3475
|
+
*
|
|
3476
|
+
* The `departAt` parameter cannot be used in conjunction with `arriveAt`.
|
|
3477
|
+
*/
|
|
3315
3478
|
departAt?: Date | string;
|
|
3316
3479
|
/** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
|
|
3317
3480
|
vehicleAxleWeight?: number;
|
|
@@ -3335,9 +3498,9 @@ export declare interface RouteRequestRouteMatrixSyncQueryParamProperties {
|
|
|
3335
3498
|
windingness?: "low" | "normal" | "high";
|
|
3336
3499
|
/** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
|
|
3337
3500
|
hilliness?: "low" | "normal" | "high";
|
|
3338
|
-
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.
|
|
3501
|
+
/** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
|
|
3339
3502
|
travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
|
|
3340
|
-
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In
|
|
3503
|
+
/** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
|
|
3341
3504
|
avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
|
|
3342
3505
|
/**
|
|
3343
3506
|
* Possible values:
|
|
@@ -3348,7 +3511,7 @@ export declare interface RouteRequestRouteMatrixSyncQueryParamProperties {
|
|
|
3348
3511
|
traffic?: boolean;
|
|
3349
3512
|
/** The type of route requested. */
|
|
3350
3513
|
routeType?: "fastest" | "shortest" | "eco" | "thrilling";
|
|
3351
|
-
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
3514
|
+
/** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
|
|
3352
3515
|
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
|
|
3353
3516
|
}
|
|
3354
3517
|
|
|
@@ -3370,21 +3533,21 @@ export declare interface Routes {
|
|
|
3370
3533
|
/** Route sections contain additional information about parts of a route. Each section contains at least the elements `startPointIndex`, `endPointIndex`, and `sectionType`. */
|
|
3371
3534
|
export declare interface RouteSectionOutput {
|
|
3372
3535
|
/** Index of the first point (offset 0) in the route this section applies to. */
|
|
3373
|
-
startPointIndex: number;
|
|
3536
|
+
readonly startPointIndex: number;
|
|
3374
3537
|
/** Index of the last point (offset 0) in the route this section applies to. */
|
|
3375
|
-
endPointIndex: number;
|
|
3538
|
+
readonly endPointIndex: number;
|
|
3376
3539
|
/** Section types of the reported route response */
|
|
3377
|
-
sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN";
|
|
3540
|
+
readonly sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN";
|
|
3378
3541
|
/** Travel mode for the calculated route. The value will be set to `other` if the requested mode of transport is not possible in this section */
|
|
3379
|
-
travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
|
|
3542
|
+
readonly travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
|
|
3380
3543
|
/** Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See "tec" for detailed information. */
|
|
3381
|
-
simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER";
|
|
3544
|
+
readonly simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER";
|
|
3382
3545
|
/** Effective speed of the incident in km/h, averaged over its entire length. */
|
|
3383
|
-
effectiveSpeedInKmh?: number;
|
|
3546
|
+
readonly effectiveSpeedInKmh?: number;
|
|
3384
3547
|
/** Delay in seconds caused by the incident. */
|
|
3385
|
-
delayInSeconds?: number;
|
|
3548
|
+
readonly delayInSeconds?: number;
|
|
3386
3549
|
/** The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the [Get Traffic Incident Detail API](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentdetail). */
|
|
3387
|
-
magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4";
|
|
3550
|
+
readonly magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4";
|
|
3388
3551
|
/** Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes elements. */
|
|
3389
3552
|
tec?: RouteSectionTecOutput;
|
|
3390
3553
|
}
|
|
@@ -3392,15 +3555,15 @@ export declare interface RouteSectionOutput {
|
|
|
3392
3555
|
/** The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions. */
|
|
3393
3556
|
export declare interface RouteSectionTecCauseOutput {
|
|
3394
3557
|
/** The main cause of the traffic event. Contains a value in the tec002:CauseCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. */
|
|
3395
|
-
mainCauseCode?: number;
|
|
3558
|
+
readonly mainCauseCode?: number;
|
|
3396
3559
|
/** The subcause of the traffic event. Contains a value in the sub cause table defined by the mainCauseCode, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. */
|
|
3397
|
-
subCauseCode?: number;
|
|
3560
|
+
readonly subCauseCode?: number;
|
|
3398
3561
|
}
|
|
3399
3562
|
|
|
3400
3563
|
/** Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes elements. */
|
|
3401
3564
|
export declare interface RouteSectionTecOutput {
|
|
3402
3565
|
/** The effect on the traffic flow. Contains a value in the tec001:EffectCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can be used to color-code traffic events according to severity. */
|
|
3403
|
-
effectCode?: number;
|
|
3566
|
+
readonly effectCode?: number;
|
|
3404
3567
|
/** Causes array */
|
|
3405
3568
|
causes?: Array<RouteSectionTecCauseOutput>;
|
|
3406
3569
|
}
|
|
@@ -3408,15 +3571,80 @@ export declare interface RouteSectionTecOutput {
|
|
|
3408
3571
|
/** Summary object */
|
|
3409
3572
|
export declare interface RouteSummaryOutput {
|
|
3410
3573
|
/** Length In Meters property */
|
|
3411
|
-
lengthInMeters: number;
|
|
3574
|
+
readonly lengthInMeters: number;
|
|
3412
3575
|
/** Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. */
|
|
3413
|
-
travelTimeInSeconds: number;
|
|
3576
|
+
readonly travelTimeInSeconds: number;
|
|
3414
3577
|
/** Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. */
|
|
3415
|
-
trafficDelayInSeconds: number;
|
|
3416
|
-
/** The estimated departure time for the route or leg. */
|
|
3417
|
-
departureTime: string;
|
|
3418
|
-
/** The estimated arrival time for the route or leg. */
|
|
3419
|
-
arrivalTime: string;
|
|
3578
|
+
readonly trafficDelayInSeconds: number;
|
|
3579
|
+
/** The estimated departure time for the route or leg. Time is in UTC. */
|
|
3580
|
+
readonly departureTime: string;
|
|
3581
|
+
/** The estimated arrival time for the route or leg. Time is in UTC. */
|
|
3582
|
+
readonly arrivalTime: string;
|
|
3583
|
+
}
|
|
3584
|
+
|
|
3585
|
+
/**
|
|
3586
|
+
* A simple poller that can be used to poll a long running operation.
|
|
3587
|
+
*/
|
|
3588
|
+
export declare interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
|
|
3589
|
+
/**
|
|
3590
|
+
* Returns true if the poller has finished polling.
|
|
3591
|
+
*/
|
|
3592
|
+
isDone(): boolean;
|
|
3593
|
+
/**
|
|
3594
|
+
* Returns the state of the operation.
|
|
3595
|
+
*/
|
|
3596
|
+
getOperationState(): TState;
|
|
3597
|
+
/**
|
|
3598
|
+
* Returns the result value of the operation,
|
|
3599
|
+
* regardless of the state of the poller.
|
|
3600
|
+
* It can return undefined or an incomplete form of the final TResult value
|
|
3601
|
+
* depending on the implementation.
|
|
3602
|
+
*/
|
|
3603
|
+
getResult(): TResult | undefined;
|
|
3604
|
+
/**
|
|
3605
|
+
* Returns a promise that will resolve once a single polling request finishes.
|
|
3606
|
+
* It does this by calling the update method of the Poller's operation.
|
|
3607
|
+
*/
|
|
3608
|
+
poll(options?: {
|
|
3609
|
+
abortSignal?: AbortSignalLike;
|
|
3610
|
+
}): Promise<TState>;
|
|
3611
|
+
/**
|
|
3612
|
+
* Returns a promise that will resolve once the underlying operation is completed.
|
|
3613
|
+
*/
|
|
3614
|
+
pollUntilDone(pollOptions?: {
|
|
3615
|
+
abortSignal?: AbortSignalLike;
|
|
3616
|
+
}): Promise<TResult>;
|
|
3617
|
+
/**
|
|
3618
|
+
* Invokes the provided callback after each polling is completed,
|
|
3619
|
+
* sending the current state of the poller's operation.
|
|
3620
|
+
*
|
|
3621
|
+
* It returns a method that can be used to stop receiving updates on the given callback function.
|
|
3622
|
+
*/
|
|
3623
|
+
onProgress(callback: (state: TState) => void): CancelOnProgress;
|
|
3624
|
+
/**
|
|
3625
|
+
* Returns a promise that could be used for serialized version of the poller's operation
|
|
3626
|
+
* by invoking the operation's serialize method.
|
|
3627
|
+
*/
|
|
3628
|
+
serialize(): Promise<string>;
|
|
3629
|
+
/**
|
|
3630
|
+
* Wait the poller to be submitted.
|
|
3631
|
+
*/
|
|
3632
|
+
submitted(): Promise<void>;
|
|
3633
|
+
/**
|
|
3634
|
+
* Returns a string representation of the poller's operation. Similar to serialize but returns a string.
|
|
3635
|
+
* @deprecated Use serialize() instead.
|
|
3636
|
+
*/
|
|
3637
|
+
toString(): string;
|
|
3638
|
+
/**
|
|
3639
|
+
* Stops the poller from continuing to poll. Please note this will only stop the client-side polling
|
|
3640
|
+
* @deprecated Use abortSignal to stop polling instead.
|
|
3641
|
+
*/
|
|
3642
|
+
stopPolling(): void;
|
|
3643
|
+
/**
|
|
3644
|
+
* Returns true if the poller is stopped.
|
|
3645
|
+
* @deprecated Use abortSignal status to track this instead.
|
|
3646
|
+
*/
|
|
3647
|
+
isStopped(): boolean;
|
|
3420
3648
|
}
|
|
3421
3649
|
|
|
3422
3650
|
/**
|