types

Basic types.

Types

ConsumptionFactorAtSpeed

used by Engine, ConsumptionValues
since 2.27

Specifies the consumption factor at a certain speed.

Field Name Type Required Default Since Description
speed Speed (double) yes - 2.27 Specifies the speed.
factor NonNegativeDouble (double) yes - 2.27 Specifies the consumption factor at the specified speed.

Cost

used by CountryCost, TollCost, TollSummary
since 2.0

Specifies monetary costs in a certain currency. For example, toll costs that have to be paid for a route.

Field Name Type Required Default Since Description
amount double yes - 2.0 The amount of the costs in the specified currency.
currency CurrencyCode (String) yes - 2.0 The currency code.

ExchangeRate

used by ExchangeRatesNotProvidedLimitation, ExchangeRates
since 2.26

Specifies an exchange rate.

Field Name Type Required Default Since Description
currency CurrencyCode (String) yes - 2.26 The currency represented by its ISO 4217 code.
rate double yes - 2.26 The exchange rate for this currency relative to the base currency. Multiplying a cost in the base currency with the exchange rate yields the cost in this currency.

ExchangeRates

used by DistanceMatrixOptions, RouteOptions
since 2.26

Specifies a set of exchange rates. PTV xServer supports 155 ISO 4217 currency codes.
Complementary and custom currency codes can be used as long as at least one currency code known to PTV xServer is specified in the rates.

Field Name Type Required Default Since Description
baseCurrency CurrencyCode (String) yes - 2.26 The currency represented by its ISO 4217 code all rates are related to.
rates ExchangeRate[] 1..* - 2.26 The exchange rates. The base currency has a rate of 1.0.

IndexInterval

used by ElevationsNotAvailableLimitation
since 2.0

Specifies an interval of indices [start, end] with both values included.

Field Name Type Required Default Since Description
start Index (int) yes - 2.0 the start index of the interval
end Index (int) yes - 2.0 the end index of the interval

IndexPair

used by IndexPairInterval
since 2.0

Specifies a pair of indices. Could be used to denote a position in a matrix or a list of lists.

Field Name Type Required Default Since Description
first Index (int) yes - 2.0 the first index value
second Index (int) yes - 2.0 the second index value

IndexPairInterval

used by ElevationsNotAvailableLimitation
since 2.0

Specifies an interval of index pairs [start, end] with both values included.

Field Name Type Required Default Since Description
start IndexPair yes - 2.0 the start index pair of the interval
end IndexPair yes - 2.0 the end index pair of the interval

KeyValuePair

used by FeatureLayerProfile, Feature, MultipleTravelTimesConsideration, FeatureDescription, Feature, ViolatedFeature, LicenseInformation
since 2.0

Type for storing a single untyped key value pair. Contains a string key and value. Interpretation of this type depends on the point of use. It is usually found in lists with keys being unique to the list unless otherwise mentioned.

Field Name Type Required Default Since Description
key String yes - 2.0 Key identifying the value.

Categories:highPerformanceRouting
value String yes - 2.0 Value identified by the key. Interpretation depends on point of use.

Categories:highPerformanceRouting

Language

used by MapFeatures
since 2.14

Specifies a language by its code and its name.

Field Name Type Required Default Since Description
code LanguageCode (String) no - 2.14 The language code.
name String no - 2.14 The language name in the respective language.

TimeZone

used by MapSegment, TimeZoneResponse
since 2.14

Specifies a time zone by its offset to UTC and daylight saving time.

Field Name Type Required Default Since Description
utcOffset UTCOffset (int) yes - 2.14 The offset to UTC in minutes.
includedDaylightSavingTime Minutes (Integer) no - 2.14 The daylight saving time included in the above offset in minutes.

Diagrams

Types