-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathptv-data.json
1937 lines (1937 loc) · 75.8 KB
/
ptv-data.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
{
"openapi": "3.0.1",
"info": {
"title": "Data",
"version": "1.10",
"description": "With the Data service you can obtain additional data such as vehicle profiles.",
"contact": {
"url": "https://developer.myptv.com/"
}
},
"tags": [
{
"name": "Map Information"
},
{
"name": "Vehicle Profiles"
},
{
"name": "Custom Road Attributes"
},
{
"name": "Vehicle Models"
}
],
"paths": {
"/vehicle-profiles/predefined": {
"get": {
"tags": [
"Vehicle Profiles"
],
"description": "Returns the predefined vehicle profiles for routing.",
"operationId": "getPredefinedVehicleProfiles",
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredefinedVehicleProfiles"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/road-attributes": {
"post": {
"tags": [
"Custom Road Attributes"
],
"operationId": "createCustomRoadAttributeScenario",
"description": "Create a custom road attribute scenario.",
"parameters": [
{
"$ref": "#/components/parameters/RoadAttributeResultsParameter"
},
{
"$ref": "#/components/parameters/PolylineFormatParameter"
}
],
"requestBody": {
"description": "The roads to be attributed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomRoadAttributeScenario"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomRoadAttributeScenario"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Custom Road Attributes"
],
"operationId": "getAllCustomRoadAttributeScenarios",
"description": "Get a list of all custom road attribute scenarios of the current user.",
"parameters": [
{
"$ref": "#/components/parameters/RoadAttributeResultsParameter"
},
{
"$ref": "#/components/parameters/PolylineFormatParameter"
}
],
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomRoadAttributeScenarioList"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/road-attributes/{scenarioId}": {
"get": {
"tags": [
"Custom Road Attributes"
],
"operationId": "getCustomRoadAttributeScenario",
"description": "Get a custom road attribute scenario by its ID.",
"parameters": [
{
"$ref": "#/components/parameters/ScenarioIdParameter"
},
{
"$ref": "#/components/parameters/RoadAttributeResultsParameter"
},
{
"$ref": "#/components/parameters/PolylineFormatParameter"
}
],
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomRoadAttributeScenario"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Custom Road Attributes"
],
"operationId": "updateCustomRoadAttributeScenario",
"description": "Perform a full update of an existing custom road attribute scenario.",
"parameters": [
{
"$ref": "#/components/parameters/ScenarioIdParameter"
},
{
"$ref": "#/components/parameters/RoadAttributeResultsParameter"
},
{
"$ref": "#/components/parameters/PolylineFormatParameter"
}
],
"requestBody": {
"description": "The custom road attribute scenario to be updated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomRoadAttributeScenario"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomRoadAttributeScenario"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Custom Road Attributes"
],
"operationId": "deleteCustomRoadAttributeScenario",
"description": "Delete a custom road attribute scenario.",
"parameters": [
{
"$ref": "#/components/parameters/ScenarioIdParameter"
}
],
"responses": {
"204": {
"description": "Response on success."
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/roads": {
"get": {
"tags": [
"Custom Road Attributes"
],
"operationId": "getRoads",
"description": "Get roads from (click) points on a map.",
"parameters": [
{
"name": "points",
"in": "query",
"required": true,
"description": "A point, a polyline or a polygon to select roads.\n\nFor a single point the road closest to this point will be returned. Several points where the first and last \npoint are different will be considered a polyline and all roads intersected by this polyline will be \nreturned. If the polyline is closed, i.e. the first and the last point are the same, the polyline defines \na polygon and all roads whose complete polyline is within the polygon will be returned. A polygon must be \nvalid according to [OGC](https://www.ogc.org/standard/sfa/). Holes within polygons are not supported.\nFerries will not be selected.\n\nFormat: `<point1_lat>,<point1_lon>,...,<pointN_lat>,<pointN_lon>`.\n\nA request will be rejected if it\n* does not contain an even number of coordinates,\n* contains a closed polyline defining an invalid polygon according to OGC,\n* contains invalid coordinates or\n* covers more than 5000 roads.",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/PolylineFormatParameter"
}
],
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadsResponse"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/map-information": {
"get": {
"tags": [
"Map Information"
],
"operationId": "getMapInformation",
"description": "Gets information about the map. See [here](./concepts/map-information) for more information.",
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MapInformationResponse"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/vehicle-models": {
"get": {
"tags": [
"Vehicle Models"
],
"description": "A list of **VehicleModel** objects. Only vehicle models matching all filters are returned.\nIn case that no vehicle model is found an empty list is returned. In case no filters are applied, all available vehicle models are returned.\n\nThis method is in a preview state, the API is stable, feature changes could be introduced in future.",
"operationId": "getVehicleModels",
"parameters": [
{
"$ref": "#/components/parameters/VehicleIdentificationFilterParameter"
},
{
"$ref": "#/components/parameters/VehicleTypesFilterParameter"
}
],
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VehicleModels"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/combined-transports": {
"get": {
"tags": [
"Map Information"
],
"operationId": "getCombinedTransports",
"description": "Get combined transports from a (click) point on a map.\n\nA request will be rejected if \n* it covers more than 5000 combined transports or\n* if the parameter **position** is not specified.",
"parameters": [
{
"name": "position",
"in": "query",
"style": "deepObject",
"schema": {
"$ref": "#/components/schemas/CombinedTransportByPosition"
},
"explode": true
},
{
"$ref": "#/components/parameters/PolylineFormatParameter"
}
],
"responses": {
"200": {
"description": "Response on success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CombinedTransportsResponse"
}
}
}
},
"default": {
"description": "Response on failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"ScenarioIdParameter": {
"name": "scenarioId",
"in": "path",
"required": true,
"description": "The ID of the custom road attribute scenario.",
"schema": {
"type": "string",
"format": "uuid"
}
},
"RoadAttributeResultsParameter": {
"name": "results",
"in": "query",
"description": "Defines which results will be returned.",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoadAttributesResults"
}
}
},
"PolylineFormatParameter": {
"name": "polylineFormat",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PolylineFormat"
}
},
"VehicleTypesFilterParameter": {
"name": "vehicleTypes",
"in": "query",
"explode": false,
"description": "A comma-separated list of vehicle types. See **vehicleType** in the response.\nThe following vehicle types are supported.\n\nTractor-like vehicle types:\n* `TRUCK` - Truck. Total permitted weight > 7.5t.\n* `LCV` - Light Commercial Vehicle. Total permitted weight < 7.5t.\n* `SCV` - Small Commercial Vehicle. Total permitted weight < 3.5t.\n\nTrailer-like vehicle types:\n* `TRAILER` - Trailer\n* `SEMI_TRAILER` - Semi-trailer\n* `BODY` - Body\n\nThis list can be extended at any time.",
"example": [
"TRUCK",
"LCV",
"SCV"
],
"schema": {
"type": "array",
"items": {
"type": "string",
"pattern": "[A-Z]+"
}
}
},
"VehicleIdentificationFilterParameter": {
"name": "identification",
"in": "query",
"description": "String which must be contained in the vehicle model or the vehicle variant. See **commercial** in the response.",
"schema": {
"type": "string"
}
}
},
"schemas": {
"Vehicle": {
"type": "object",
"description": "Physical and legal properties of the vehicle such as its dimensions.\n\nThese parameters are not supported for non-motorized profiles such as _BICYCLE_ or _PEDESTRIAN_.\nUnsupported parameters such as **electricityType** for combustion vehicles will not be present in the response.",
"properties": {
"engineType": {
"$ref": "#/components/schemas/EngineType"
},
"fuelType": {
"$ref": "#/components/schemas/FuelType"
},
"electricityType": {
"$ref": "#/components/schemas/ElectricityType"
},
"averageFuelConsumption": {
"description": "The average fuel consumption of the vehicle.\nDepending on the **fuelType** [l/100km] for liquid fuel types or [kg/100km] for gaseous fuel types.\n\nSupported for **engineType** _COMBUSTION_ or _HYBRID_. Relevant for `emissions`.\n",
"type": "number",
"format": "double",
"minimum": 0,
"exclusiveMinimum": true,
"example": 35
},
"averageElectricityConsumption": {
"description": "The average power consumption of the vehicle [kWh/100km].\n\nSupported for **engineType** _ELECTRIC_ or _HYBRID_. Relevant for `emissions`.\n",
"type": "number",
"format": "double",
"minimum": 0,
"exclusiveMinimum": true,
"example": 115
},
"bioFuelRatio": {
"description": "The ratio of biofuel to conventional fuel [%], i.e. 10 for E10 with 10% biofuel.\n\nSupported for **engineType** _COMBUSTION_ or _HYBRID_ and only for the fuel types _GASOLINE_, _DIESEL_, _CNG_GASOLINE_ and _LNG_GASOLINE_.\nRelevant for `emissions`.\n",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 100,
"example": 0
},
"hybridRatio": {
"description": "Electric energy usage ratio from the total amount of energy consumed by the vehicle.\n\nSupported for **engineType** _HYBRID_. Relevant for `emissions`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 99,
"example": 50
},
"dualFuelRatio": {
"description": "Ratio of CNG or LPG usage from the total amount of fuel consumption.\n\nSupported for **engineType** _COMBUSTION_ with **fuelType** _CNG_GASOLINE_ or _LPG_GASOLINE_. Relevant for `emissions`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 99,
"example": 50
},
"cylinderCapacity": {
"description": "The cylinder capacity of the vehicle [cm³].\n\nSupported for **engineType** _COMBUSTION_ or _HYBRID_.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 12000
},
"emissionStandard": {
"$ref": "#/components/schemas/EmissionStandard"
},
"co2EmissionClass": {
"description": "The CO₂ emission class valid in the European Union. See also the \n[Directive 1999/62/EC](https://eur-lex.europa.eu/eli/dir/1999/62/2022-03-24) of the European Parliament and \nof the Council on the charging of heavy goods vehicles for the use of certain infrastructures, Article 7ga.\n\nRelevant for `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 5,
"example": 1
},
"lowEmissionZoneTypes": {
"description": "Comma-separated list of the low-emission zone types of the vehicle.\nThis parameter is deprecated and superseded by **lowEmissionZoneApprovals**.\n\nRelevant for `routing`.\n",
"deprecated": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LowEmissionZoneTypes"
}
},
"lowEmissionZoneApprovals": {
"description": "Comma-separated list of approvals to enter low-emission zones.\nUsually, such approvals are environmental badges to be placed on the windscreen,\nbut that can also be any other kind of approval or vehicle registration\nallowing it to enter a low-emission zone.\n\nLow-emission zones which do not need any kind of approval but depend only on the **emissionStandard**\nare not affected by this parameter. Instead they can be entered if the **emissionStandard** \nis sufficient. Electric vehicles can always enter these zones.\n\nAvailable values are: \n\"NONE\", \"AT_EURO_1\", \"AT_EURO_2\", \"AT_EURO_3\", \"AT_EURO_4\", \"AT_EURO_5\", \"AT_EURO_6\",\n\"DE_GREEN\", \"DE_YELLOW\", \"DE_RED\", \"DK_AUTHORIZED\", \"ES_CAT_B\", \"ES_CAT_C\", \"ES_CAT_ECO\", \"ES_CAT_ZERO\",\n\"FR_CRITAIR_0\", \"FR_CRITAIR_1\", \"FR_CRITAIR_2\", \"FR_CRITAIR_3\", \"FR_CRITAIR_4\", \"FR_CRITAIR_5\"\n\nThis list can be extended at any time, clients should handle unknown values properly. Relevant for `routing`.\n",
"type": "array",
"items": {
"type": "string",
"x-extensible-enum": [
"NONE",
"AT_EURO_1",
"AT_EURO_2",
"AT_EURO_3",
"AT_EURO_4",
"AT_EURO_5",
"AT_EURO_6",
"DE_GREEN",
"DE_YELLOW",
"DE_RED",
"DK_AUTHORIZED",
"ES_CAT_B",
"ES_CAT_C",
"ES_CAT_ECO",
"ES_CAT_ZERO",
"FR_CRITAIR_0",
"FR_CRITAIR_1",
"FR_CRITAIR_2",
"FR_CRITAIR_3",
"FR_CRITAIR_4",
"FR_CRITAIR_5"
]
}
},
"particleReductionClass": {
"$ref": "#/components/schemas/ParticleReductionClass"
},
"emptyWeight": {
"description": "The empty weight of the vehicle [kg].\n\nRelevant for `routing`, `emissions`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 15000
},
"loadWeight": {
"description": "The weight of the vehicle's load [kg].\n\nRelevant for `routing`, `emissions`.\n",
"type": "integer",
"format": "int32",
"minimum": 0,
"example": 25000
},
"totalPermittedWeight": {
"description": "The total permitted weight of the vehicle and load [kg].\n\nRelevant for `routing`, `toll`, `emissions`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 40000
},
"totalTechnicallyPermittedWeight": {
"description": "The total technically permitted weight of the vehicle and load [kg].\nSometimes vehicles are registered with a smaller permitted weight than technically possible. For \nsuch cases the possibly larger total technically permitted weight is specified here, it is relevant for \ntoll calculation in some European countries.\n\nRelevant for `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 40000
},
"axleWeight": {
"description": "The maximum distributed weight that may be supported by an axle of the vehicle [kg].\n\nRelevant for `routing`, `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 11500
},
"numberOfAxles": {
"description": "The total number of axles of the vehicle including the trailers.\n\nRelevant for `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 5
},
"numberOfTires": {
"description": "The total number of tires of the vehicle including the trailers.\n\nRelevant for `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 10
},
"height": {
"description": "The height of the vehicle [cm].\n\nRelevant for `routing`, `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 400
},
"heightAboveFrontAxle": {
"description": "The height above the front axle [cm].\n\nRelevant for `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 400
},
"length": {
"description": "The length of the vehicle [cm].\n\nRelevant for `routing`, `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 1650
},
"width": {
"description": "The width of the vehicle [cm].\n\nRelevant for `routing`, `toll`.\n",
"type": "integer",
"format": "int32",
"minimum": 1,
"example": 254
},
"hazardousMaterials": {
"description": "Comma-separated list of hazardous materials the vehicle has loaded.\n\nRelevant for `routing`.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/HazardousMaterials"
}
},
"tunnelRestrictionCode": {
"$ref": "#/components/schemas/TunnelRestrictionCode"
},
"truckRoutes": {
"$ref": "#/components/schemas/TruckRoutesList"
},
"commercial": {
"description": "Specifies if the vehicle usage is commercial.\n\nRelevant for `toll`.\n",
"type": "boolean",
"example": false
},
"etcSubscriptions": {
"description": "A comma separated list of ETC Subscriptions.\nSee [here](../routing-api/concepts/electronic-toll-collection) for more information on available subscriptions.\n\nRelevant for `toll`.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/EtcSubscriptionTypes"
}
}
}
},
"EngineType": {
"type": "string",
"description": "The engine type of the vehicle.\n\nRelevant for `toll`, `emissions`, `range calculation`.\n",
"example": "COMBUSTION",
"enum": [
"COMBUSTION",
"ELECTRIC",
"HYBRID"
],
"x-enum-varnames": [
"COMBUSTION",
"ELECTRIC",
"HYBRID"
]
},
"FuelType": {
"type": "string",
"description": "The fuel type of the vehicle.\nThe fuel types _CNG_GASOLINE_ and _LNG_GASOLINE_ are used for dual-fuel vehicles.\n\nSupported for **engineType** _COMBUSTION_ and _HYBRID_. Relevant for `emissions`.\n",
"example": "DIESEL",
"enum": [
"GASOLINE",
"DIESEL",
"COMPRESSED_NATURAL_GAS",
"LIQUEFIED_PETROLEUM_GAS",
"LIQUEFIED_NATURAL_GAS",
"CNG_GASOLINE",
"LPG_GASOLINE",
"ETHANOL",
"NONE"
],
"x-enum-varnames": [
"GASOLINE",
"DIESEL",
"COMPRESSED_NATURAL_GAS",
"LIQUEFIED_PETROLEUM_GAS",
"LIQUEFIED_NATURAL_GAS",
"CNG_GASOLINE",
"LPG_GASOLINE",
"ETHANOL",
"NONE"
]
},
"ElectricityType": {
"type": "string",
"description": "The electricity type of the vehicle.\n\nSupported for **engineType** _ELECTRIC_ or _HYBRID_. Relevant for `emissions`.\n",
"example": "BATTERY",
"enum": [
"BATTERY",
"HYDROGEN_FUEL_CELL",
"NONE"
],
"x-enum-varnames": [
"BATTERY",
"HYDROGEN_FUEL_CELL",
"NONE"
]
},
"EmissionStandard": {
"type": "string",
"description": "The emission standard of the vehicle valid in the European Union.\nThis parameter is not only important for toll and emission calculation but also for considering \nlow-emission zones which can be entered only if the vehicle has a proper emission standard.\nIn contrast to explicit approvals like environmental badges or vehicle registrations\nthe emission standard is automatically considered when entering such low-emission zones.\n\nValues different from _NONE_ are supported for **engineType** _COMBUSTION_ and _HYBRID_. Relevant for `routing`, `toll`, `emissions`.\n",
"example": "EURO_6",
"enum": [
"NONE",
"EURO_0",
"EURO_1",
"EURO_2",
"EURO_3",
"EURO_4",
"EURO_5",
"EURO_EEV",
"EURO_6",
"EURO_6C",
"EURO_6D_TEMP",
"EURO_6D",
"EURO_6E",
"EURO_7"
],
"x-enum-varnames": [
"NONE",
"EURO_0",
"EURO_1",
"EURO_2",
"EURO_3",
"EURO_4",
"EURO_5",
"EURO_EEV",
"EURO_6",
"EURO_6C",
"EURO_6D_TEMP",
"EURO_6D",
"EURO_6E",
"EURO_7"
]
},
"LowEmissionZoneTypes": {
"type": "string",
"enum": [
"DE_GREEN",
"DE_YELLOW",
"DE_RED",
"DE_NONE"
],
"x-enum-varnames": [
"DE_GREEN",
"DE_YELLOW",
"DE_RED",
"DE_NONE"
]
},
"ParticleReductionClass": {
"type": "string",
"example": "PMK_0",
"description": "The particle reduction class (Partikelminderungsklasse) according to 'Anlage XIV zu § 48 StVZO' (German law).\n\nSupported for **engineType** _COMBUSTION_ and _HYBRID_. Relevant for `toll`.\n",
"enum": [
"PMK_0",
"PMK_1",
"PMK_2",
"PMK_3",
"PMK_4",
"NONE"
],
"x-enum-varnames": [
"PMK_0",
"PMK_1",
"PMK_2",
"PMK_3",
"PMK_4",
"NONE"
]
},
"HazardousMaterials": {
"type": "string",
"example": "OTHER",
"enum": [
"HAZARDOUS_TO_WATER",
"EXPLOSIVE",
"FLAMMABLE",
"RADIOACTIVE",
"INHALATION_HAZARD",
"MEDICAL_WASTE",
"OTHER",
"NONE"
],
"x-enum-varnames": [
"HAZARDOUS_TO_WATER",
"EXPLOSIVE",
"FLAMMABLE",
"RADIOACTIVE",
"INHALATION_HAZARD",
"MEDICAL_WASTE",
"OTHER",
"NONE"
]
},
"TunnelRestrictionCode": {
"type": "string",
"example": "NONE",
"description": "The tunnel restriction code according to ADR (European Agreement Concerning the International Carriage of Dangerous Goods by Road) depending on the load of the vehicle.\n\nRelevant for `routing`.\n",
"enum": [
"NONE",
"B",
"C",
"D",
"E"
],
"x-enum-varnames": [
"NONE",
"B",
"C",
"D",
"E"
]
},
"TruckRoutesList": {
"description": "Comma-separated list of truck routes the vehicle has to follow.\nThis parameter will be ignored for non-truck profiles such as EUR_CAR, EUR_VAN, USA_1_PICKUP or AUS_LCV_LIGHT_COMMERCIAL.\n * `DE_LKWUEBERLSTVAUSNV`\n Preferred routes for long trucks in Germany, also known as Lang-LKW.\n * `NL_LZV`\n Preferred routes for long trucks in the Netherlands, also known as LZV (Langere en Zwaardere Vrachtautocombinatie).\n * `NZ_HPMV`\n The network for High Productivity Motor Vehicles (HPMV) carrying the maximum loads available under a permit (New Zeland Transport Agency).\n * `SE_BK_1`\n Public roads and bridges that support up to 64 t total permitted weight (Swedish Transport Administration).\n * `SE_BK_2`\n Public roads and bridges that support up to 51.4 t total permitted weight.\n Actual limit depends on wheelbase and axle weight (Swedish Transport Administration).\n * `SE_BK_3`\n Public roads and bridges that support up to 37.5 t total permitted weight.\n Actual limit depends on wheelbase and axle weight (Swedish Transport Administration).\n * `SE_BK_4`\n Public roads and bridges that support up to 74 t total permitted weight (draft summer 2018, Swedish Transport Administration).\n * `US_STAA`\n Routes that belong to the highway network as defined by the Surface Transportation Assistance Act in the US.\n * `US_TD`\n Part of a state-designated highway network for trucks in the US.\n * `AU_B_DOUBLE`\n B-Double routes as defined in Australia.\n * `AU_B_DOUBLE_HML`\n Routes for B-Double vehicle combinations operating at Higher Mass Limits (HML) (Australian Transport Administration).\n * `AU_B_TRIPLE`\n B-Triple routes as defined in Australia.\n * `AU_B_TRIPLE_HML`\n Routes for B-Triple vehicle combinations operating at Higher Mass Limits (HML) (Australian Transport Administration).\n * `AU_AB_TRIPLE`\n Routes for AB-Triple vehicle combinations operating (Australian Transport Administration).\n * `AU_AB_TRIPLE_HML`\n Routes for AB-Triple vehicle combinations operating at Higher Mass Limits (HML) (Australian Transport Administration).\n * `NONE`\n Not used.\n\nRelevant for `routing`.\nCannot be used with **options[routingMode]=MONETARY**.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/TruckRoutes"
}
},
"TruckRoutes": {
"type": "string",
"example": "SE_BK_1",
"enum": [
"DE_LKWUEBERLSTVAUSNV",
"NL_LZV",
"NZ_HPMV",
"SE_BK_1",
"SE_BK_2",
"SE_BK_3",
"SE_BK_4",
"US_STAA",
"US_TD",
"AU_B_DOUBLE",
"AU_B_DOUBLE_HML",
"AU_B_TRIPLE",
"AU_B_TRIPLE_HML",
"AU_AB_TRIPLE",
"AU_AB_TRIPLE_HML",
"NONE"
],
"x-enum-varnames": [
"DE_LKWUEBERLSTVAUSNV",
"NL_LZV",
"NZ_HPMV",
"SE_BK_1",
"SE_BK_2",
"SE_BK_3",
"SE_BK_4",
"US_STAA",
"US_TD",
"AU_B_DOUBLE",
"AU_B_DOUBLE_HML",
"AU_B_TRIPLE",
"AU_B_TRIPLE_HML",
"AU_AB_TRIPLE",
"AU_AB_TRIPLE_HML",
"NONE"
]
},
"EtcSubscriptionTypes": {
"type": "string",
"example": "DE_TOLLCOLLECT",
"enum": [
"AT_GOBOX",
"BE_TELETOL",
"BE_VIAPASS",
"CH_LSVA",
"DE_QUICKBOX",
"DE_TOLLCOLLECT",
"DE_WARNOWTUNNEL_RFID",
"DK_BROPAS_BUSINESS",
"IT_TELEPASS",
"NL_TELECARD",
"NL_TTAG",
"NO_AUTOPASS",
"PT_VIA_VERDE",
"US_APASS",
"US_BREEZEBY",
"US_DOWNBEACH_EXPRESSPASS",
"US_EPASS",
"US_EXPRESSACCOUNT",
"US_EXPRESSCARD",
"US_EXPRESSPASS",
"US_EXPRESSTOLL",
"US_EZPASS",
"US_EZTAG",
"US_FASTRAK",
"US_GEAUXPASS",
"US_GOODTOGO",
"US_GOPASS",
"US_IPASS",
"US_KTAG",
"US_LEEWAY",
"US_MACKINACBRIDGE_MACPASS",
"US_MARYLAND_EZPASS",
"US_MASSACHUSETTS_EZPASS",
"US_NC_QUICKPASS",
"US_NEWHAMPSHIRE_EZPASS",
"US_NEWJERSEY_EZPASS",
"US_NEWYORK_EZPASS",
"US_NEXPRESS",
"US_OHIO_EZPASS",
"US_PALPASS",
"US_PIKEPASS",
"US_RIVERLINK",
"US_RIVERLINK_NOTRANSPONDER",
"US_SEAWAYTRANSITCARD",
"US_SUNPASS",
"US_TOLLTAG",
"US_TXTAG",
"US_VIRGINIA_EZPASS",
"US_WESTVIRGINIA_EZPASS",
"US_PEACHPASS",
"US_NEXUS",
"US_DELAWARE_EZPASS",
"US_GROSSEILETOLLBRIDGE_PASSTAG",
"US_EZPASS_PAYBYPLATE"
],
"x-enum-varnames": [
"AT_GOBOX",
"BE_TELETOL",
"BE_VIAPASS",
"CH_LSVA",
"DE_QUICKBOX",
"DE_TOLLCOLLECT",
"DE_WARNOWTUNNEL_RFID",
"DK_BROPAS_BUSINESS",
"IT_TELEPASS",
"NL_TELECARD",
"NL_TTAG",
"NO_AUTOPASS",
"PT_VIA_VERDE",
"US_APASS",
"US_BREEZEBY",
"US_DOWNBEACH_EXPRESSPASS",
"US_EPASS",
"US_EXPRESSACCOUNT",
"US_EXPRESSCARD",
"US_EXPRESSPASS",
"US_EXPRESSTOLL",
"US_EZPASS",