-
Notifications
You must be signed in to change notification settings - Fork 18
/
atlas.service.Models.RoutePostRouteDirectionsOptionalParams.yml
1118 lines (935 loc) · 33.8 KB
/
atlas.service.Models.RoutePostRouteDirectionsOptionalParams.yml
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
### YamlMime:TSType
name: RoutePostRouteDirectionsOptionalParams
uid: azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams
package: azure-maps-rest
summary: Optional Parameters.
fullName: RoutePostRouteDirectionsOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
- name: accelerationEfficiency
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.accelerationEfficiency
package: azure-maps-rest
summary: >
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**.
Must be paired with **decelerationEfficiency**.
The range of values allowed are 0.0 to 1/**decelerationEfficiency**.
Sensible Values : for **Combustion Model** : 0.33, for **Electric Model**
: 0.66
fullName: accelerationEfficiency
remarks: ''
isDeprecated: false
syntax:
content: 'accelerationEfficiency?: number'
return:
description: ''
type: number
- name: alternativeType
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.alternativeType
package: azure-maps-rest
summary: >-
Controls the optimality, with respect to the given planning criteria, of
the calculated
alternatives compared to the reference route. Possible values include:
'anyRoute',
'betterRoute'
fullName: alternativeType
remarks: ''
isDeprecated: false
syntax:
content: 'alternativeType?: AlternativeRouteType'
return:
description: ''
type: >-
<xref uid="azure-maps-rest.atlas.service.Models.AlternativeRouteType"
/>
- name: arriveAt
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.arriveAt
package: azure-maps-rest
summary: >-
The date and time of arrival at the destination point. It must be
specified as a dateTime.
When a time zone offset is not specified it will be assumed to be that of
the destination
point. The arriveAt value must be in the future. The arriveAt parameter
cannot be used in
conjunction with departAt, minDeviationDistance or minDeviationTime.
fullName: arriveAt
remarks: ''
isDeprecated: false
syntax:
content: 'arriveAt?: Date'
return:
description: ''
type: Date
- name: auxiliaryPowerInkW
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.auxiliaryPowerInkW
package: azure-maps-rest
summary: >
Specifies the amount of power consumed for sustaining auxiliary systems,
in kilowatts (kW).
It can be used to specify consumption due to devices and systems such as
AC systems, radio,
heating, etc.
Sensible Values : 1.7
fullName: auxiliaryPowerInkW
remarks: ''
isDeprecated: false
syntax:
content: 'auxiliaryPowerInkW?: string'
return:
description: ''
type: string
- name: auxiliaryPowerInLitersPerHour
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.auxiliaryPowerInLitersPerHour
package: azure-maps-rest
summary: >
Specifies the amount of fuel consumed for sustaining auxiliary systems of
the vehicle, in
liters per hour.
It can be used to specify consumption due to devices and systems such as
AC systems, radio,
heating, etc.
Sensible Values : 0.2
fullName: auxiliaryPowerInLitersPerHour
remarks: ''
isDeprecated: false
syntax:
content: 'auxiliaryPowerInLitersPerHour?: number'
return:
description: ''
type: number
- name: avoid
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.avoid
package: azure-maps-rest
summary: >-
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
calculateReachableRange requests, the
value alreadyUsedRoads must not be used. Possible values include:
'tollRoads', 'motorways',
'ferries', 'unpavedRoads', 'carpools', 'alreadyUsedRoads',
'borderCrossings'
fullName: avoid
remarks: ''
isDeprecated: false
syntax:
content: 'avoid?: Avoid[]'
return:
description: ''
type: '<xref uid="azure-maps-rest.atlas.service.Models.Avoid" />[]'
- name: computeBestOrder
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.computeBestOrder
package: azure-maps-rest
summary: >-
Re-order the route waypoints to reduce the route length. Yields best
results when used in
conjunction with routeType _shortest_. 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_.
fullName: computeBestOrder
remarks: ''
isDeprecated: false
syntax:
content: 'computeBestOrder?: boolean'
return:
description: ''
type: boolean
- name: computeTravelTimeFor
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.computeTravelTimeFor
package: azure-maps-rest
summary: >-
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. Possible
values include: 'none', 'all'
fullName: computeTravelTimeFor
remarks: ''
isDeprecated: false
syntax:
content: 'computeTravelTimeFor?: ComputeTravelTimeFor'
return:
description: ''
type: >-
<xref uid="azure-maps-rest.atlas.service.Models.ComputeTravelTimeFor"
/>
- name: constantSpeedConsumptionInkWhPerHundredkm
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.constantSpeedConsumptionInkWhPerHundredkm
package: azure-maps-rest
summary: >
Specifies the speed-dependent component of consumption.
Provided 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:
* by linear interpolation, if the given speed lies in between two speeds
in the list
* by linear extrapolation otherwise, assuming a constant
(ΔConsumption/ΔSpeed) determined by
the nearest two points in the list
The 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.
Consumption 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.
Similarly, consumption values specified for the two smallest speeds in the
list cannot lead to
a negative consumption rate for any smaller speed.
The valid range for the consumption values(expressed in kWh/100km) is
between 0.01 and
100000.0.
Sensible Values : 50,8.2:130,21.3
This parameter is required for **Electric consumption model**.
fullName: constantSpeedConsumptionInkWhPerHundredkm
remarks: ''
isDeprecated: false
syntax:
content: 'constantSpeedConsumptionInkWhPerHundredkm?: string'
return:
description: ''
type: string
- name: constantSpeedConsumptionInLitersPerHundredkm
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.constantSpeedConsumptionInLitersPerHundredkm
package: azure-maps-rest
summary: >
Specifies the speed-dependent component of consumption.
Provided 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:
* by linear interpolation, if the given speed lies in between two speeds
in the list
* by linear extrapolation otherwise, assuming a constant
(ΔConsumption/ΔSpeed) determined by
the nearest two points in the list
The 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.
Consumption 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.
Similarly, consumption values specified for the two smallest speeds in the
list cannot lead to
a negative consumption rate for any smaller speed.
The valid range for the consumption values(expressed in l/100km) is
between 0.01 and 100000.0.
Sensible Values : 50,6.3:130,11.5
**Note** : This parameter is required for **The Combustion Consumption
Model**.
fullName: constantSpeedConsumptionInLitersPerHundredkm
remarks: ''
isDeprecated: false
syntax:
content: 'constantSpeedConsumptionInLitersPerHundredkm?: number'
return:
description: ''
type: number
- name: currentChargeInkWh
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.currentChargeInkWh
package: azure-maps-rest
summary: |
Specifies the current electric energy supply in kilowatt hours (kWh).
This parameter co-exists with **maxChargeInkWh** parameter.
The range of values allowed are 0.0 to **maxChargeInkWh**.
Sensible Values : 43
fullName: currentChargeInkWh
remarks: ''
isDeprecated: false
syntax:
content: 'currentChargeInkWh?: string'
return:
description: ''
type: string
- name: currentFuelInLiters
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.currentFuelInLiters
package: azure-maps-rest
summary: |
Specifies the current supply of fuel in liters.
Sensible Values : 55
fullName: currentFuelInLiters
remarks: ''
isDeprecated: false
syntax:
content: 'currentFuelInLiters?: number'
return:
description: ''
type: number
- name: decelerationEfficiency
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.decelerationEfficiency
package: azure-maps-rest
summary: >
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**.
Must be paired with **accelerationEfficiency**.
The range of values allowed are 0.0 to 1/**accelerationEfficiency**.
Sensible Values : for **Combustion Model** : 0.83, for **Electric Model**
: 0.91
fullName: decelerationEfficiency
remarks: ''
isDeprecated: false
syntax:
content: 'decelerationEfficiency?: number'
return:
description: ''
type: number
- name: departAt
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.departAt
package: azure-maps-rest
summary: >-
The date and time of departure from the origin point. Departure times
apart from now must be
specified as a dateTime. When a time zone offset is not specified, it will
be assumed to be
that of the origin point. The departAt value must be in the future in the
date-time format
(1996-12-19T16:39:57-08:00).
fullName: departAt
remarks: ''
isDeprecated: false
syntax:
content: 'departAt?: Date'
return:
description: ''
type: Date
- name: downhillEfficiency
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.downhillEfficiency
package: azure-maps-rest
summary: >
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**.
Must be paired with **uphillEfficiency**.
The range of values allowed are 0.0 to 1/**uphillEfficiency**.
Sensible Values : for **Combustion Model** : 0.51, for **Electric Model**
: 0.73
fullName: downhillEfficiency
remarks: ''
isDeprecated: false
syntax:
content: 'downhillEfficiency?: number'
return:
description: ''
type: number
- name: fuelEnergyDensityInMJoulesPerLiter
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.fuelEnergyDensityInMJoulesPerLiter
package: azure-maps-rest
summary: >
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.
This parameter is required if any ***Efficiency** parameter is set.
Sensible Values : 34.2
fullName: fuelEnergyDensityInMJoulesPerLiter
remarks: ''
isDeprecated: false
syntax:
content: 'fuelEnergyDensityInMJoulesPerLiter?: number'
return:
description: ''
type: number
- name: hilliness
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.hilliness
package: azure-maps-rest
summary: >-
Degree of hilliness for thrilling route. This parameter can only be used
in conjunction with
`routeType`=thrilling. Possible values include: 'low', 'normal', 'high'
fullName: hilliness
remarks: ''
isDeprecated: false
syntax:
content: 'hilliness?: Hilliness'
return:
description: ''
type: <xref uid="azure-maps-rest.atlas.service.Models.Hilliness" />
- name: instructionsType
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.instructionsType
package: azure-maps-rest
summary: >-
If specified, guidance instructions will be returned. Note that the
instructionsType parameter
cannot be used in conjunction with routeRepresentation=none. Possible
values include: 'coded',
'text', 'tagged'
fullName: instructionsType
remarks: ''
isDeprecated: false
syntax:
content: 'instructionsType?: RouteInstructionsType'
return:
description: ''
type: >-
<xref uid="azure-maps-rest.atlas.service.Models.RouteInstructionsType"
/>
- name: language
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.language
package: azure-maps-rest
summary: >-
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
fullName: language
remarks: ''
isDeprecated: false
syntax:
content: 'language?: string'
return:
description: ''
type: string
- name: maxAlternatives
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.maxAlternatives
package: azure-maps-rest
summary: >-
Number of desired alternative routes to be calculated. Default: 0,
minimum: 0 and maximum: 5
fullName: maxAlternatives
remarks: ''
isDeprecated: false
syntax:
content: 'maxAlternatives?: number'
return:
description: ''
type: number
- name: maxChargeInkWh
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.maxChargeInkWh
package: azure-maps-rest
summary: >
Specifies the maximum electric energy supply in kilowatt hours (kWh) that
may be stored in the
vehicle's battery.
This parameter co-exists with **currentChargeInkWh** parameter.
Minimum value has to be greater than or equal to **currentChargeInkWh**.
Sensible Values : 85
fullName: maxChargeInkWh
remarks: ''
isDeprecated: false
syntax:
content: 'maxChargeInkWh?: string'
return:
description: ''
type: string
- name: minDeviationDistance
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.minDeviationDistance
package: azure-maps-rest
summary: >-
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
fullName: minDeviationDistance
remarks: ''
isDeprecated: false
syntax:
content: 'minDeviationDistance?: number'
return:
description: ''
type: number
- name: minDeviationTime
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.minDeviationTime
package: azure-maps-rest
summary: >-
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
fullName: minDeviationTime
remarks: ''
isDeprecated: false
syntax:
content: 'minDeviationTime?: number'
return:
description: ''
type: number
- name: report
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.report
package: azure-maps-rest
summary: >-
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.
fullName: report
remarks: ''
isDeprecated: false
syntax:
content: 'report?: string'
return:
description: ''
type: string
- name: routeRepresentation
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.routeRepresentation
package: azure-maps-rest
summary: >-
Specifies the representation of the set of routes provided as response.
This parameter value
can only be used in conjunction with computeBestOrder=true. Possible
values include:
'polyline', 'summaryOnly', 'none'
fullName: routeRepresentation
remarks: ''
isDeprecated: false
syntax:
content: 'routeRepresentation?: RouteRepresentation'
return:
description: ''
type: >-
<xref uid="azure-maps-rest.atlas.service.Models.RouteRepresentation"
/>
- name: routeType
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.routeType
package: azure-maps-rest
summary: >-
The type of route requested. Possible values include: 'fastest',
'shortest', 'eco',
'thrilling'
fullName: routeType
remarks: ''
isDeprecated: false
syntax:
content: 'routeType?: RouteType'
return:
description: ''
type: <xref uid="azure-maps-rest.atlas.service.Models.RouteType" />
- name: sectionType
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.sectionType
package: azure-maps-rest
summary: >-
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.
Multiple types can be used. The default sectionType refers to the
travelMode input. By default
travelMode is set to car. Possible values include: 'carTrain', 'country',
'ferry', 'motorway',
'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode',
'tunnel'
fullName: sectionType
remarks: ''
isDeprecated: false
syntax:
content: 'sectionType?: SectionType'
return:
description: ''
type: <xref uid="azure-maps-rest.atlas.service.Models.SectionType" />
- name: traffic
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.traffic
package: azure-maps-rest
summary: >-
Possible values:
* true - Do consider all available traffic information during routing
* false - Ignore current traffic data during routing. Note that although
the current traffic
data is ignored
during routing, the effect of historic traffic on effective road speeds is
still incorporated.
fullName: traffic
remarks: ''
isDeprecated: false
syntax:
content: 'traffic?: boolean'
return:
description: ''
type: boolean
- name: travelMode
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.travelMode
package: azure-maps-rest
summary: >-
The mode of travel for the requested route. 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. In **calculateReachableRange**
requests, the values
bicycle and pedestrian must not be used. Possible values include: 'car',
'truck', 'taxi',
'bus', 'van', 'motorcycle', 'bicycle', 'pedestrian'
fullName: travelMode
remarks: ''
isDeprecated: false
syntax:
content: 'travelMode?: TravelMode'
return:
description: ''
type: <xref uid="azure-maps-rest.atlas.service.Models.TravelMode" />
- name: uphillEfficiency
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.uphillEfficiency
package: azure-maps-rest
summary: >
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**.
Must be paired with **downhillEfficiency**.
The range of values allowed are 0.0 to 1/**downhillEfficiency**.
Sensible Values : for **Combustion Model** : 0.27, for **Electric Model**
: 0.74
fullName: uphillEfficiency
remarks: ''
isDeprecated: false
syntax:
content: 'uphillEfficiency?: number'
return:
description: ''
type: number
- name: vehicleAxleWeight
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleAxleWeight
package: azure-maps-rest
summary: >-
Weight per axle of the vehicle in kg. A value of 0 means that weight
restrictions per axle are
not considered.
fullName: vehicleAxleWeight
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleAxleWeight?: number'
return:
description: ''
type: number
- name: vehicleCommercial
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleCommercial
package: azure-maps-rest
summary: >-
Vehicle is used for commercial purposes and thus may not be allowed to
drive on some roads.
fullName: vehicleCommercial
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleCommercial?: boolean'
return:
description: ''
type: boolean
- name: vehicleEngineType
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleEngineType
package: azure-maps-rest
summary: >-
Engine type of the vehicle. When a detailed Consumption Model is
specified, it must be
consistent with the value of **vehicleEngineType**. Possible values
include: 'combustion',
'electric'
fullName: vehicleEngineType
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleEngineType?: VehicleEngineType'
return:
description: ''
type: <xref uid="azure-maps-rest.atlas.service.Models.VehicleEngineType" />
- name: vehicleHeading
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleHeading
package: azure-maps-rest
summary: >-
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
fullName: vehicleHeading
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleHeading?: number'
return:
description: ''
type: number
- name: vehicleHeight
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleHeight
package: azure-maps-rest
summary: >-
Height of the vehicle in meters. A value of 0 means that height
restrictions are not
considered.
fullName: vehicleHeight
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleHeight?: number'
return:
description: ''
type: number
- name: vehicleLength
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleLength
package: azure-maps-rest
summary: >-
Length of the vehicle in meters. A value of 0 means that length
restrictions are not
considered.
fullName: vehicleLength
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleLength?: number'
return:
description: ''
type: number
- name: vehicleLoadType
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleLoadType
package: azure-maps-rest
summary: >-
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. Possible
values include: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3',
'USHazmatClass4',
'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8',
'USHazmatClass9',
'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'
fullName: vehicleLoadType
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleLoadType?: VehicleLoadType'
return:
description: ''
type: <xref uid="azure-maps-rest.atlas.service.Models.VehicleLoadType" />
- name: vehicleMaxSpeed
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleMaxSpeed
package: azure-maps-rest
summary: >-
Maximum speed of the vehicle in km/hour. A value of 0 means that an
appropriate value for the
vehicle will be determined and applied during route planning. A non-zero
value may be
overridden during route planning.
fullName: vehicleMaxSpeed
remarks: ''
isDeprecated: false
syntax:
content: 'vehicleMaxSpeed?: number'
return:
description: ''
type: number
- name: vehicleWeight
uid: >-
azure-maps-rest.atlas.service.Models.RoutePostRouteDirectionsOptionalParams.vehicleWeight
package: azure-maps-rest
summary: >
Weight of the vehicle in kilograms.
* It is mandatory if any of the *Efficiency parameters are set.
* It must be strictly positive when used in the context of the Consumption
Model. Weight
restrictions are considered.
* If no detailed **Consumption Model** is specified and the value of
**vehicleWeight** is
non-zero, then weight restrictions are considered.
* In all other cases, this parameter is ignored.