HapiTripRequest

class HapiTripRequest : HapiRequest<HapiTripList>

Types

Companion
Link copied to clipboard
object Companion

Functions

clear
Link copied to clipboard
open override fun clear()
containsKey
Link copied to clipboard
open override fun containsKey(key: String): Boolean
containsValue
Link copied to clipboard
open override fun containsValue(value: String): Boolean
get
Link copied to clipboard
open operator override fun get(key: String): String?
isEmpty
Link copied to clipboard
open override fun isEmpty(): Boolean
put
Link copied to clipboard
open override fun put(key: String, value: String): String?
putAll
Link copied to clipboard
open override fun putAll(from: Map<out String, String>)
remove
Link copied to clipboard
open override fun remove(key: String): String?

Properties

accessId
Link copied to clipboard
var accessId: String?

Access ID for identifying the requesting client

addChangeTime
Link copied to clipboard
var addChangeTime: Duration?

This amount of minutes is added to the change time at each stop

attributes
Link copied to clipboard
var attributes: HapiFilterList?

Filter trips by one or more attribute codes of a journey. Multiple attribute codes are separated by comma. If the attribute should not be part of the be trip, negate it by putting ! in front of it

avoid
Link copied to clipboard
var avoid: String?

Complex structure to provide multiple points to be avoided separated by semicolon

avoidId
Link copied to clipboard
var avoidId: String?

ID of a station/stop to be avoided as transfer stop for the trip. Such IDs can be retrieved from the location.name or location.nearbystops services

avoidPaths
Link copied to clipboard
var avoidPaths: List<String>?

Only path not having the given properties will be part of the result

baim
Link copied to clipboard
var baim: Boolean?

Enables/disables BAIM search and response

bikeCarriage
Link copied to clipboard
var bikeCarriage: Boolean?

Enables/disables search for trips explicit allowing bike carriage

blockingList
Link copied to clipboard
var blockingList: String?

Defines a section of a route of a journey not to be used within the trip search

changeTimePercent
Link copied to clipboard
var changeTimePercent: Int?

Configures the walking speed when changing from one leg of the journey to the next one. It extends the time required for changes by a specified percentage. A value of 200 doubles the change time as initially calculated by the system

context
Link copied to clipboard
var context: String?

Defines the starting point for the scroll back or forth operation. Use the scrB value from a previous result to scroll backwards in time and use the scrF value to scroll forth

couchetteCar
Link copied to clipboard
var couchetteCar: Boolean?

Enables/disables search for trips having couchette coach

date
Link copied to clipboard
var date: LocalDate?

Sets the start date for which the departures shall be retrieved. Represented in the format YYYY-MM-DD

destBike
Link copied to clipboard
var destBike: Boolean?

Enables/disables using bike routes at the end of a trip when searching to an address

destCar
Link copied to clipboard
var destCar: Boolean?

Enables/disables using car routes at the end of a trip when searching to an address

destCoordLat
Link copied to clipboard
var destCoordLat: Double?

Latitude of station/stop coordinate of the trip’s destination. The coordinate can be retrieved from the location.name or location.nearbystops services

destCoordLong
Link copied to clipboard
var destCoordLong: Double?

Longitude of station/stop coordinate of the trip’s destination. The coordinate can be retrieved from the location.name or location.nearbystops services

destCoordName
Link copied to clipboard
var destCoordName: String?

Name of the trip's destination

destExtId
Link copied to clipboard
var destExtId: String?

Specifies the external station/stop ID of the destination for the trip. Such ID can be retrieved from the location.name or location.nearbystops services

destId
Link copied to clipboard
var destId: String?

Specifies the station/stop ID of the destination for the trip. Such ID can be retrieved from the location.name or location.nearbystops services

destMeta
Link copied to clipboard
var destMeta: Boolean?

Enables using one or more predefined individual transport meta profile at the end of a trip. The profiles are defined in the HAFAS installation

destPark
Link copied to clipboard
var destPark: Boolean?

Enables/disables using Park and Ride at the end of a trip when searching to an address

destTaxi
Link copied to clipboard
var destTaxi: Boolean?

Enables/disables using taxi rides at the end of a trip when searching to an address

destWalk
Link copied to clipboard
var destWalk: Boolean?

Enables/disables using footpaths at the end of a trip when searching to an address

eco
Link copied to clipboard
var eco: Boolean?

Enables/disables eco value calculation

ecoCmp
Link copied to clipboard
var ecoCmp: Boolean?

Enables/disables eco comparison

economic
Link copied to clipboard
var economic: Boolean?

Enables/disables economic search mode

ecoParams
Link copied to clipboard
var ecoParams: String?

Provide additional eco parameters

entries
Link copied to clipboard
open override val entries: MutableSet<MutableMap.MutableEntry<String, String>>
fattributes
Link copied to clipboard
var fattributes: HapiFilterList?

Filter trips by one or more footway attribute codes of a journey. Multiple attribute codes are separated by comma. If the attribute should not be part of the be trip, negate it by putting ! in front of it

groupFilter
Link copied to clipboard
var groupFilter: String?

Use a predefined group filter to query for certain modes

includeEarlier
Link copied to clipboard
var includeEarlier: Boolean?

Disables search optimization in relation of duration

includeIv
Link copied to clipboard
var includeIv: Boolean?

Enables/disables search for individual transport routes

ivOnly
Link copied to clipboard
var ivOnly: Boolean?

Enables/disables search for individual transport routes only

keys
Link copied to clipboard
open override val keys: MutableSet<String>
lang
Link copied to clipboard
var lang: String?

The language of the journey planer

lineids
Link copied to clipboard
var lineids: HapiFilterList?

Only journeys running the given line (identified by its line ID) are part of the result. o filter multiple lines, separate the line IDs by comma. If the line should not be part of the be trip, negate it by putting ! in front of it

lines
Link copied to clipboard
var lines: HapiFilterList?

Only journeys running the given line are part of the result. To filter multiple lines, separate the codes by comma. If the line should not be part of the be trip, negate it by putting ! in front of it

maxChange
Link copied to clipboard
var maxChange: Int?

Maximum number of changes. Range from 0 to 11

maxChangeTime
Link copied to clipboard
var maxChangeTime: Duration?

Maximum change time at stop in minutes

minChangeTime
Link copied to clipboard
var minChangeTime: Duration?

Minimum change time at stop in minutes

mobilityProfile
Link copied to clipboard
var mobilityProfile: HapiFilterList?

Use a predefined filter by its name. The filters are defined in the HAFAS installation. If the filter should be negated, put a ! in front of its name

numB
Link copied to clipboard
var numB: Int?

Minimum number of trips before the search time. Sum of numF and numB has to be less or equal 6. Range from 0 to 6

numF
Link copied to clipboard
var numF: Int?

Minimum number of trips after the search time. Sum of numF and numB has to be less or equal 6. Range from 0 to 6

operators
Link copied to clipboard
var operators: HapiFilterList?

Only trips provided by the given operators are part of the result. To filter multiple operators, separate the codes by comma. If the operator should not be part of the be trip, negate it by putting ! in front of it

originBike
Link copied to clipboard
var originBike: Boolean?

Enables/disables using bike routes in the beginning of a trip when searching from an address

originCar
Link copied to clipboard
var originCar: Boolean?

Enables/disables using car in the beginning of a trip when searching from an address

originCoordLat
Link copied to clipboard
var originCoordLat: Double?

Latitude of station/stop coordinate of the trip’s origin. The coordinate can be retrieved from the location.name or location.nearbystops services

originCoordLong
Link copied to clipboard
var originCoordLong: Double?

Longitude of station/stop coordinate of the trip’s origin. The coordinate can be retrieved from the location.name or location.nearbystops services

originCoordName
Link copied to clipboard
var originCoordName: String?

Name of the trip's origin

originExtId
Link copied to clipboard
var originExtId: String?

Specifies the external station/stop ID of the origin for the trip. Such ID can be retrieved from the location.name or location.nearbystops services

originId
Link copied to clipboard
var originId: String?

Specifies the station/stop ID of the origin for the trip. Such ID can be retrieved from the location.name or location.nearbystops services

originMeta
Link copied to clipboard
var originMeta: Boolean?

Enables using one or more predefined individual transport meta profile at the beginning of a trip. The profiles are defined in the HAFAS installation

originPark
Link copied to clipboard
var originPark: Boolean?

Enables/disables using Park and Ride in the beginning of a trip when searching from an address

originTaxi
Link copied to clipboard
var originTaxi: Boolean?

Enables/disables using taxi rides in the beginning of a trip when searching from an address

originWalk
Link copied to clipboard
var originWalk: Boolean?

Enables/disables using footpaths in the beginning of a trip when searching from an address

passlist
Link copied to clipboard
var passlist: Boolean?

Enables/disables the return of the passlist for each leg of the trip

poly
Link copied to clipboard
var poly: Boolean?

Enables/disables the calculation of the polyline for each leg of the trip except any GIS route

polyEnc
Link copied to clipboard
var polyEnc: HafasPolylineEncoding?

Defines encoding of the returned polyline

products
Link copied to clipboard
var products: Int?

Decimal value defining the product classes to be included in the search. It represents a bitmask combining bit number of a product as defined in the HAFAS raw data file zugart

requestId
Link copied to clipboard
var requestId: String?

Request ID for identifying the request

rtMode
Link copied to clipboard
var rtMode: HafasRealtimeMode?

Set the realtime mode to be used

sattributes
Link copied to clipboard
var sattributes: HapiFilterList?

Filter trips by one or more station attribute codes of a journey. Multiple attribute codes are separated by comma. If the attribute should not be part of the be trip, negate it by putting ! in front of it

searchForArrival
Link copied to clipboard
var searchForArrival: Boolean?

If set, the date and time parameters specify the arrival time for the trip search instead of the departure time

showPassingPoints
Link copied to clipboard
var showPassingPoints: Boolean?

Enables/disables the return of stops having no alighting and boarding in its passlist for each leg of the trip. Needs passlist enabled

size
Link copied to clipboard
open override val size: Int
sleepingCar
Link copied to clipboard
var sleepingCar: Boolean?

Enables/disables search for trips having sleeping car

tariff
Link copied to clipboard
var tariff: Boolean?

Enables/disables the output of tariff data. The default is configurable via provisioning

time
Link copied to clipboard
var time: LocalTime?

Sets the start time for which the departures shall be retrieved. Represented in the format hh:mm:ss in 24h nomenclature. Seconds will be ignored for requests

totalBike
Link copied to clipboard
var totalBike: Boolean?

Enables/disables using bike routes for the whole trip

totalCar
Link copied to clipboard
var totalCar: Boolean?

Enables/disables using car routes for the whole trip

totalMeta
Link copied to clipboard
var totalMeta: Boolean?

Enables using one or more predefined individual transport meta profile for a trip. The profiles are defined in the HAFAS installation

totalTaxi
Link copied to clipboard
var totalTaxi: Boolean?

Enables/disables using taxi rides for the whole trip

totalWalk
Link copied to clipboard
var totalWalk: Boolean?

Enables/disables using footpaths for the whole trip

trafficMessages
Link copied to clipboard
var trafficMessages: Boolean?

Enables/disables the output of traffic messages. The default is configurable via provisioning

trainComposition
Link copied to clipboard
var trainComposition: Boolean?

Enables/disables train composition data

trainFilter
Link copied to clipboard
var trainFilter: String?

Filters a trip search for a certain train

unsharp
Link copied to clipboard
var unsharp: Boolean?

Enables/disables unsharp search mode

values
Link copied to clipboard
open override val values: MutableCollection<String>
via
Link copied to clipboard
var via: String?

Complex structure to provide multiple via points separated by semicolon

viaId
Link copied to clipboard
var viaId: String?

ID of a station/stop used as a via for the trip. Specifying a via station forces the trip search to look for trips which must pass through this station. Such IDs can be retrieved from the location.name or location.nearbystops services

viaWaitTime
Link copied to clipboard
var viaWaitTime: Duration?

Defines the waiting time spent at via station in minutes

withICTAlternatives
Link copied to clipboard
var withICTAlternatives: Boolean?

Enables/disables the search for alternatives with individualized change times (ICT)