RouteResultLegSummary interface
Summary object for route section.
Properties
arrival |
Arrival Time property NOTE: This property will not be serialized. It can only be populated by the server. |
battery |
Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model. Included if vehicleEngineType is set to electric and constantSpeedConsumptionInkWhPerHundredkm is specified. The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy). If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh. If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation. NOTE: This property will not be serialized. It can only be populated by the server. |
departure |
Departure Time property NOTE: This property will not be serialized. It can only be populated by the server. |
fuel |
Estimated fuel consumption in liters using the Combustion Consumption Model. Included if vehicleEngineType is set to combustion and constantSpeedConsumptionInLitersPerHundredkm is specified. The value will be non-negative. NOTE: This property will not be serialized. It can only be populated by the server. |
historic |
Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query. NOTE: This property will not be serialized. It can only be populated by the server. |
length |
Length In Meters property NOTE: This property will not be serialized. It can only be populated by the server. |
live |
Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query. NOTE: This property will not be serialized. It can only be populated by the server. |
no |
Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query. NOTE: This property will not be serialized. It can only be populated by the server. |
traffic |
Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. NOTE: This property will not be serialized. It can only be populated by the server. |
travel |
Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
arrivalTime
Arrival Time property NOTE: This property will not be serialized. It can only be populated by the server.
arrivalTime?: string
Property Value
string
batteryConsumptionInkWh
Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model. Included if vehicleEngineType is set to electric and constantSpeedConsumptionInkWhPerHundredkm is specified. The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy). If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh. If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation. NOTE: This property will not be serialized. It can only be populated by the server.
batteryConsumptionInkWh?: number
Property Value
number
departureTime
Departure Time property NOTE: This property will not be serialized. It can only be populated by the server.
departureTime?: string
Property Value
string
fuelConsumptionInLiters
Estimated fuel consumption in liters using the Combustion Consumption Model. Included if vehicleEngineType is set to combustion and constantSpeedConsumptionInLitersPerHundredkm is specified. The value will be non-negative. NOTE: This property will not be serialized. It can only be populated by the server.
fuelConsumptionInLiters?: number
Property Value
number
historicTrafficTravelTimeInSeconds
Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query. NOTE: This property will not be serialized. It can only be populated by the server.
historicTrafficTravelTimeInSeconds?: number
Property Value
number
lengthInMeters
Length In Meters property NOTE: This property will not be serialized. It can only be populated by the server.
lengthInMeters?: number
Property Value
number
liveTrafficIncidentsTravelTimeInSeconds
Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query. NOTE: This property will not be serialized. It can only be populated by the server.
liveTrafficIncidentsTravelTimeInSeconds?: number
Property Value
number
noTrafficTravelTimeInSeconds
Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query. NOTE: This property will not be serialized. It can only be populated by the server.
noTrafficTravelTimeInSeconds?: number
Property Value
number
trafficDelayInSeconds
Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. NOTE: This property will not be serialized. It can only be populated by the server.
trafficDelayInSeconds?: number
Property Value
number
travelTimeInSeconds
Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. NOTE: This property will not be serialized. It can only be populated by the server.
travelTimeInSeconds?: number
Property Value
number