-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
route.json
2949 lines (2949 loc) · 153 KB
/
route.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Route Service",
"version": "1.0",
"description": "Azure Maps Route REST APIs"
},
"host": "atlas.microsoft.com",
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json"
],
"securityDefinitions": {
"AADToken": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).",
"scopes": {
"https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
}
},
"SharedKey": {
"type": "apiKey",
"description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"name": "subscription-key",
"in": "query"
},
"SasToken": {
"type": "apiKey",
"description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.",
"name": "SAS Token",
"in": "header"
}
},
"security": [
{
"AADToken": [
"https://atlas.microsoft.com/.default"
]
},
{
"SharedKey": []
},
{
"SasToken": []
}
],
"responses": {},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
"in": "query",
"required": true,
"default": "1.0",
"x-ms-parameter-location": "client"
},
"VehicleLoadType": {
"name": "vehicleLoadType",
"in": "query",
"description": "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.",
"type": "string",
"enum": [
"USHazmatClass1",
"USHazmatClass2",
"USHazmatClass3",
"USHazmatClass4",
"USHazmatClass5",
"USHazmatClass6",
"USHazmatClass7",
"USHazmatClass8",
"USHazmatClass9",
"otherHazmatExplosive",
"otherHazmatGeneral",
"otherHazmatHarmfulToWater"
],
"x-ms-enum": {
"name": "VehicleLoadType",
"modelAsString": true,
"values": [
{
"value": "USHazmatClass1",
"description": "Explosives"
},
{
"value": "USHazmatClass2",
"description": "Compressed gas"
},
{
"value": "USHazmatClass3",
"description": "Flammable liquids"
},
{
"value": "USHazmatClass4",
"description": "Flammable solids"
},
{
"value": "USHazmatClass5",
"description": "Oxidizers"
},
{
"value": "USHazmatClass6",
"description": "Poisons"
},
{
"value": "USHazmatClass7",
"description": "Radioactive"
},
{
"value": "USHazmatClass8",
"description": "Corrosives"
},
{
"value": "USHazmatClass9",
"description": "Miscellaneous"
},
{
"value": "otherHazmatExplosive",
"description": "Explosives"
},
{
"value": "otherHazmatGeneral",
"description": "Miscellaneous"
},
{
"value": "otherHazmatHarmfulToWater",
"description": "Harmful to water"
}
]
},
"x-ms-parameter-location": "method"
},
"RouteType": {
"name": "routeType",
"in": "query",
"description": "The type of route requested.",
"type": "string",
"enum": [
"fastest",
"shortest",
"eco",
"thrilling"
],
"x-ms-enum": {
"name": "RouteType",
"modelAsString": true,
"values": [
{
"value": "fastest",
"name": "Fastest",
"description": "The fastest route."
},
{
"value": "shortest",
"name": "Shortest",
"description": "The shortest route by distance."
},
{
"value": "eco",
"name": "Economy",
"description": "A route balanced by economy and speed."
},
{
"value": "thrilling",
"name": "Thrilling",
"description": "Includes interesting or challenging roads and uses as few motorways as possible. You can choose the level of turns included and also the degree of hilliness. See the hilliness and windingness parameters for how to set this. There is a limit of 900 km on routes planned with `routeType`=thrilling"
}
]
},
"x-ms-parameter-location": "method"
},
"WindingnessLevel": {
"name": "windingness",
"in": "query",
"description": "Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling.",
"type": "string",
"enum": [
"low",
"normal",
"high"
],
"x-ms-enum": {
"name": "WindingnessLevel",
"modelAsString": true,
"values": [
{
"value": "low",
"description": "low"
},
{
"value": "normal",
"description": "normal"
},
{
"value": "high",
"description": "high"
}
]
},
"x-ms-parameter-location": "method"
},
"InclineLevel": {
"name": "hilliness",
"x-ms-client-name": "inclineLevel",
"in": "query",
"description": "Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling.",
"type": "string",
"enum": [
"low",
"normal",
"high"
],
"x-ms-enum": {
"name": "InclineLevel",
"modelAsString": true,
"values": [
{
"value": "low",
"description": "low"
},
{
"value": "normal",
"description": "normal"
},
{
"value": "high",
"description": "high"
}
]
},
"x-ms-parameter-location": "method"
},
"TravelMode": {
"name": "travelMode",
"in": "query",
"description": "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.",
"type": "string",
"enum": [
"car",
"truck",
"taxi",
"bus",
"van",
"motorcycle",
"bicycle",
"pedestrian"
],
"x-ms-enum": {
"name": "TravelMode",
"modelAsString": true,
"values": [
{
"value": "car",
"description": "The returned routes are optimized for cars."
},
{
"value": "truck",
"description": "The returned routes are optimized for commercial vehicles, like for trucks."
},
{
"value": "taxi",
"description": "The returned routes are optimized for taxis. BETA functionality."
},
{
"value": "bus",
"description": "The returned routes are optimized for buses, including the use of bus only lanes. BETA functionality."
},
{
"value": "van",
"description": "The returned routes are optimized for vans. BETA functionality."
},
{
"value": "motorcycle",
"description": "The returned routes are optimized for motorcycles. BETA functionality."
},
{
"value": "bicycle",
"description": "The returned routes are optimized for bicycles, including use of bicycle lanes."
},
{
"value": "pedestrian",
"description": "The returned routes are optimized for pedestrians, including the use of sidewalks."
}
]
},
"x-ms-parameter-location": "method"
},
"TravelModeRange": {
"name": "travelMode",
"in": "query",
"description": "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.",
"type": "string",
"enum": [
"car",
"truck",
"taxi",
"bus",
"van",
"motorcycle"
],
"x-ms-enum": {
"name": "TravelMode",
"modelAsString": true,
"values": [
{
"value": "car",
"description": "The returned routes are optimized for cars."
},
{
"value": "truck",
"description": "The returned routes are optimized for commercial vehicles, like for trucks."
},
{
"value": "taxi",
"description": "The returned routes are optimized for taxis. BETA functionality."
},
{
"value": "bus",
"description": "The returned routes are optimized for buses, including the use of bus only lanes. BETA functionality."
},
{
"value": "van",
"description": "The returned routes are optimized for vans. BETA functionality."
},
{
"value": "motorcycle",
"description": "The returned routes are optimized for motorcycles. BETA functionality."
}
]
},
"x-ms-parameter-location": "method"
},
"RouteAvoidList": {
"name": "avoid",
"in": "query",
"description": "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.",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string",
"enum": [
"tollRoads",
"motorways",
"ferries",
"unpavedRoads",
"carpools",
"alreadyUsedRoads",
"borderCrossings"
],
"x-ms-enum": {
"name": "RouteAvoidType",
"modelAsString": true,
"values": [
{
"value": "tollRoads",
"description": "Avoids toll roads."
},
{
"value": "motorways",
"description": "Avoids motorways"
},
{
"value": "ferries",
"description": "Avoids ferries"
},
{
"value": "unpavedRoads",
"description": "Avoids unpaved roads"
},
{
"value": "carpools",
"description": "Avoids routes that require the use of carpool (HOV/High Occupancy Vehicle) lanes."
},
{
"value": "alreadyUsedRoads",
"description": "Avoids using the same road multiple times. Most useful in conjunction with `routeType`=thrilling."
},
{
"value": "borderCrossings",
"description": "Avoids border crossings in route calculation."
}
]
}
},
"x-ms-parameter-location": "method"
},
"VehicleEngineType": {
"name": "vehicleEngineType",
"in": "query",
"description": "Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**.",
"type": "string",
"enum": [
"combustion",
"electric"
],
"x-ms-enum": {
"name": "VehicleEngineType",
"modelAsString": true,
"values": [
{
"value": "combustion",
"description": "Internal combustion engine."
},
{
"value": "electric",
"description": "Electric engine."
}
]
},
"x-ms-parameter-location": "method"
},
"ConstantSpeedConsumptionInLitersPerHundredkm": {
"x-ms-client-name": "ConstantSpeedConsumptionInLitersPerHundredKm",
"name": "constantSpeedConsumptionInLitersPerHundredkm",
"in": "query",
"description": "\n\nSpecifies the speed-dependent component of consumption.\n\nProvided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:\n\n * by linear interpolation, if the given speed lies in between two speeds in the list\n\n * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list\n\nThe list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.\n\nConsumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.\n\nSimilarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.\n\nThe valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.\n\nSensible Values : 50,6.3:130,11.5\n\n**Note** : This parameter is required for **The Combustion Consumption Model**.",
"type": "string",
"x-ms-parameter-location": "method"
},
"CurrentFuelInLiters": {
"name": "currentFuelInLiters",
"in": "query",
"description": "Specifies the current supply of fuel in liters.\n\nSensible Values : 55",
"type": "number",
"format": "double",
"x-ms-parameter-location": "method"
},
"AuxiliaryPowerInLitersPerHour": {
"name": "auxiliaryPowerInLitersPerHour",
"in": "query",
"description": "Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.\n\nIt can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.\n\nSensible Values : 0.2",
"type": "number",
"format": "double",
"x-ms-parameter-location": "method"
},
"FuelEnergyDensityInMJoulesPerLiter": {
"x-ms-client-name": "FuelEnergyDensityInMegajoulesPerLiter",
"name": "fuelEnergyDensityInMJoulesPerLiter",
"in": "query",
"description": "Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the ***Efficiency** parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.\n\nThis parameter is required if any ***Efficiency** parameter is set.\n\nSensible Values : 34.2",
"type": "number",
"format": "double",
"x-ms-parameter-location": "method"
},
"AccelerationEfficiency": {
"name": "accelerationEfficiency",
"in": "query",
"description": "Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates _(i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **decelerationEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**decelerationEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.33, for **Electric Model** : 0.66",
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 1,
"x-ms-parameter-location": "method"
},
"DecelerationEfficiency": {
"name": "decelerationEfficiency",
"in": "query",
"description": "Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates _(i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **accelerationEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**accelerationEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.83, for **Electric Model** : 0.91",
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 1,
"x-ms-parameter-location": "method"
},
"UphillEfficiency": {
"name": "uphillEfficiency",
"in": "query",
"description": "Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation _(i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **downhillEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**downhillEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.27, for **Electric Model** : 0.74",
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 1,
"x-ms-parameter-location": "method"
},
"DownhillEfficiency": {
"name": "downhillEfficiency",
"in": "query",
"description": "Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation _(i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **uphillEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**uphillEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.51, for **Electric Model** : 0.73",
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 1,
"x-ms-parameter-location": "method"
},
"ConstantSpeedConsumptionInkWhPerHundredkm": {
"name": "constantSpeedConsumptionInkWhPerHundredkm",
"x-ms-client-name": "ConstantSpeedConsumptionInKwHPerHundredKm",
"in": "query",
"description": "Specifies the speed-dependent component of consumption.\n\nProvided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:\n\n* by linear interpolation, if the given speed lies in between two speeds in the list\n\n* by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list\n\nThe list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.\n\nConsumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.\n\nSimilarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.\n\nThe valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.\n\nSensible Values : 50,8.2:130,21.3\n\nThis parameter is required for **Electric consumption model**.",
"type": "string",
"x-ms-parameter-location": "method"
},
"CurrentChargeInkWh": {
"name": "currentChargeInkWh",
"x-ms-client-name": "CurrentChargeInKwH",
"in": "query",
"description": "Specifies the current electric energy supply in kilowatt hours (kWh).\n\nThis parameter co-exists with **maxChargeInkWh** parameter.\n\nThe range of values allowed are 0.0 to **maxChargeInkWh**.\n\nSensible Values : 43",
"type": "number",
"format": "double",
"x-ms-parameter-location": "method"
},
"MaxChargeInkWh": {
"name": "maxChargeInkWh",
"x-ms-client-name": "MaxChargeInKwH",
"in": "query",
"description": "Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.\n\nThis parameter co-exists with **currentChargeInkWh** parameter.\n\nMinimum value has to be greater than or equal to **currentChargeInkWh**.\n\nSensible Values : 85",
"type": "number",
"format": "double",
"x-ms-parameter-location": "method"
},
"AuxiliaryPowerInkW": {
"name": "auxiliaryPowerInkW",
"x-ms-client-name": "AuxiliaryPowerInKw",
"in": "query",
"description": "Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).\n\nIt can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.\n\nSensible Values : 1.7",
"type": "number",
"format": "double",
"x-ms-parameter-location": "method"
},
"VehicleWeightMatrix": {
"name": "vehicleWeight",
"in": "query",
"description": "Weight of the vehicle in kilograms.",
"type": "integer",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleWeight": {
"name": "vehicleWeight",
"in": "query",
"description": "Weight of the vehicle in kilograms.\n\n* It is mandatory if any of the *Efficiency parameters are set.\n\n* It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.\n\n* If no detailed **Consumption Model** is specified and the value of **vehicleWeight** is non-zero, then weight restrictions are considered.\n\n* In all other cases, this parameter is ignored.\n\nSensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900",
"type": "integer",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleMaxSpeed": {
"name": "vehicleMaxSpeed",
"in": "query",
"description": "Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. \n\n* A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.\n\n* A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.",
"type": "integer",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleLength": {
"name": "vehicleLength",
"in": "query",
"description": "Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.",
"type": "number",
"format": "double",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleHeight": {
"name": "vehicleHeight",
"in": "query",
"description": "Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.",
"type": "number",
"format": "double",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleWidth": {
"name": "vehicleWidth",
"in": "query",
"description": "Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.",
"type": "number",
"format": "double",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleAxleWeight": {
"name": "vehicleAxleWeight",
"in": "query",
"description": "Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.",
"type": "integer",
"default": 0,
"x-ms-parameter-location": "method"
},
"VehicleCommercial": {
"name": "vehicleCommercial",
"x-ms-client-name": "isCommercialVehicle",
"in": "query",
"description": "Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads.",
"type": "boolean",
"default": false,
"x-ms-parameter-location": "method"
},
"DepartAt": {
"name": "departAt",
"in": "query",
"description": "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.\n * Default value: now\n * Other value: `dateTime`\n\nExamples:\n * 2023-12-19T16:39:57\n * 2023-12-19T16:39:57-08:00\n\nThe `departAt` parameter cannot be used in conjunction with `arriveAt`.",
"type": "string",
"format": "date-time",
"x-ms-parameter-location": "method"
},
"ArriveAt": {
"name": "arriveAt",
"in": "query",
"description": "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.\n\nExamples:\n * 2023-12-19T16:39:57\n * 2023-12-19T16:39:57-08:00\n\nThe `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.",
"type": "string",
"format": "date-time",
"x-ms-parameter-location": "method"
},
"SectionType": {
"name": "sectionType",
"x-ms-client-name": "FilterSectionType",
"in": "query",
"description": "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",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string",
"enum": [
"carTrain",
"country",
"ferry",
"motorway",
"pedestrian",
"tollRoad",
"tollVignette",
"traffic",
"travelMode",
"tunnel",
"carpool",
"urban"
],
"x-ms-enum": {
"name": "SectionType",
"modelAsString": true,
"values": [
{
"value": "carTrain",
"name": "CarOrTrain",
"description": "Sections of the route that are cars or trains."
},
{
"value": "country",
"name": "Country",
"description": "Sections indicating which countries/regions the route is in."
},
{
"value": "ferry",
"name": "Ferry",
"description": "Sections of the route that are ferries."
},
{
"value": "motorway",
"name": "Motorway",
"description": "Sections of the route that are motorways."
},
{
"value": "pedestrian",
"name": "Pedestrian",
"description": "Sections of the route that are only suited for pedestrians."
},
{
"value": "tollRoad",
"name": "TollRoad",
"description": "Sections of the route that require a toll to be paid."
},
{
"value": "tollVignette",
"name": "TollVignette",
"description": "Sections of the route that require a toll vignette to be present."
},
{
"value": "traffic",
"name": "Traffic",
"description": "Sections of the route that contain traffic information."
},
{
"value": "travelMode",
"name": "TravelMode",
"description": "Sections in relation to the request parameter `travelMode`."
},
{
"value": "tunnel",
"name": "Tunnel",
"description": "Sections of the route that are tunnels."
},
{
"value": "carpool",
"name": "Carpool",
"description": "Sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes."
},
{
"value": "urban",
"name": "Urban",
"description": "Sections of the route that are located within urban areas."
}
]
}
},
"x-ms-parameter-location": "method"
},
"ComputeBestOrder": {
"name": "computeBestOrder",
"x-ms-client-name": "computeBestWaypointOrder",
"in": "query",
"description": "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_.",
"type": "boolean",
"x-ms-parameter-location": "method"
},
"RouteRepresentationForBestOrder": {
"name": "routeRepresentation",
"x-ms-client-name": "routeRepresentationForBestOrder",
"in": "query",
"description": "Specifies the representation of the set of routes provided as response.",
"type": "string",
"enum": [
"polyline",
"summaryOnly",
"none"
],
"x-ms-enum": {
"name": "RouteRepresentationForBestOrder",
"modelAsString": true,
"values": [
{
"value": "polyline",
"description": "Includes route geometry in the response."
},
{
"value": "summaryOnly",
"description": "Summary as per polyline but excluding the point geometry elements for the routes in the response."
},
{
"value": "none",
"description": "Includes only the optimized waypoint indices but does not include the route geometry in the response. This parameter value can only be used in conjunction with computeBestOrder=true."
}
]
},
"x-ms-parameter-location": "method"
},
"ComputeTravelTime": {
"name": "computeTravelTimeFor",
"x-ms-client-name": "computeTravelTime",
"in": "query",
"description": "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.",
"type": "string",
"enum": [
"none",
"all"
],
"x-ms-enum": {
"name": "ComputeTravelTime",
"modelAsString": true,
"values": [
{
"value": "none",
"description": "Does not compute additional travel times."
},
{
"value": "all",
"description": "Computes travel times for all types of traffic information and specifies all results in the fields noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds and liveTrafficIncidentsTravelTimeInSeconds being included in the summaries in the route response."
}
]
},
"x-ms-parameter-location": "method"
},
"VehicleHeading": {
"name": "vehicleHeading",
"in": "query",
"description": "The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359",
"type": "integer",
"minimum": 0,
"maximum": 359,
"x-ms-parameter-location": "method"
},
"Report": {
"name": "report",
"in": "query",
"description": "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.",
"type": "string",
"x-ms-parameter-location": "method",
"enum": [
"effectiveSettings"
],
"x-ms-enum": {
"name": "Report",
"modelAsString": true,
"values": [
{
"value": "effectiveSettings",
"description": "Reports the effective parameters or data used when calling the API."
}
]
}
},
"Traffic": {
"name": "traffic",
"x-ms-client-name": "useTrafficData",
"in": "query",
"description": "Possible values: \n * true - Do consider all available traffic information during routing\n * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored \n during routing, the effect of historic traffic on effective road speeds is still incorporated.",
"type": "boolean",
"x-ms-parameter-location": "method"
},
"AlternativeRouteType": {
"name": "alternativeType",
"in": "query",
"description": "Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.",
"type": "string",
"enum": [
"anyRoute",
"betterRoute"
],
"x-ms-enum": {
"name": "AlternativeRouteType",
"modelAsString": true,
"values": [
{
"value": "anyRoute",
"description": "Allow any alternative route to be returned irrespective of how it compares to the reference route in terms of optimality."
},
{
"value": "betterRoute",
"description": "Return an alternative route only if it is better than the reference route according to the given planning criteria."
}
]
},
"x-ms-parameter-location": "method"
},
"RouteInstructionsType": {
"name": "instructionsType",
"in": "query",
"description": "If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none.",
"type": "string",
"enum": [
"coded",
"text",
"tagged"
],
"x-ms-enum": {
"name": "RouteInstructionsType",
"modelAsString": true,
"values": [
{
"value": "coded",
"description": "Returns raw instruction data without human-readable messages."
},
{
"value": "text",
"description": "Returns raw instructions data with human-readable messages in plain text."
},
{
"value": "tagged",
"description": "Returns raw instruction data with tagged human-readable messages to permit formatting. A human-readable message is built up from repeatable identified elements. These are tagged to allow client applications to format them correctly. The following message components are tagged when instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.\n\nExample of tagged 'Turn left' message:\n\n```\nTurn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>\ntowards <signpostText>Den Haag</signpostText>\n```"
}
]
},
"x-ms-parameter-location": "method"
},
"MatrixId": {
"name": "format",
"x-ms-client-name": "matrixId",
"description": "Matrix id received after the Matrix Route request was accepted successfully.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"BatchId": {
"name": "format",
"x-ms-client-name": "batchId",
"description": "Batch id for querying the operation.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"Query": {
"name": "query",
"x-ms-client-name": "routePoints",
"in": "query",
"description": "The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/route/matrix/{format}": {
"post": {
"summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request.",
"description": "\n\nThe `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.\n\n\nFor 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.\n\n\nThe 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).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf 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).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe 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.\n\n\nThe 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).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > 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.\n\n\n3. 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:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST 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.\n\n### Download Async Results\nWhen 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:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.",
"operationId": "Route_PostRouteMatrix",
"x-ms-client-name": "RequestRouteMatrix",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"Successfully submit a route matrix request": {
"$ref": "./examples/PostRouteMatrix.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "waitForResults",
"in": "query",
"description": "Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**.",
"type": "boolean"
},
{
"$ref": "#/parameters/ComputeTravelTime"
},
{
"$ref": "#/parameters/SectionType"
},
{
"$ref": "#/parameters/ArriveAt"
},
{
"$ref": "#/parameters/DepartAt"
},
{
"$ref": "#/parameters/VehicleAxleWeight"
},
{
"$ref": "#/parameters/VehicleLength"
},
{
"$ref": "#/parameters/VehicleHeight"
},
{
"$ref": "#/parameters/VehicleWidth"
},
{
"$ref": "#/parameters/VehicleMaxSpeed"
},
{
"$ref": "#/parameters/VehicleWeightMatrix"
},
{
"$ref": "#/parameters/WindingnessLevel"
},
{
"$ref": "#/parameters/InclineLevel"
},
{
"$ref": "#/parameters/TravelMode"
},
{
"$ref": "#/parameters/RouteAvoidList"
},
{
"$ref": "#/parameters/Traffic"
},
{
"$ref": "#/parameters/RouteType"
},
{
"$ref": "#/parameters/VehicleLoadType"
},
{
"name": "routeMatrixQuery",
"description": "The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RouteMatrixQuery"
}
}
],
"responses": {
"200": {
"description": "Matrix request successfully processed. The response body contains all of the results.",
"schema": {
"$ref": "#/definitions/RouteMatrixResult"
}
},
"202": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/202Async"
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"get": {
"summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations.",
"description": "\n\nThe `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).\n\nFor 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.\n\n\nFor 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.\n\n\nThe 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).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf 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).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe 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.\n\n\nThe 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).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > 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.\n\n\n3. 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:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen 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.\n\n### Download Async Results\nWhen 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:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.",
"operationId": "Route_GetRouteMatrix",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri"