HapiArrivalBoardRequest

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

attributes
Link copied to clipboard
var attributes: HapiFilterList?

Filter boards 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 result, negate it by putting ! in front of it

date
Link copied to clipboard
var date: LocalDate?

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

direction
Link copied to clipboard
var direction: String?

If only vehicles departing or arriving from a certain direction shall be returned, specify the direction by giving the station/stop ID of the last stop on the journey

dur
Link copied to clipboard
var dur: Duration?

Range from 0 to 1439

duration
Link copied to clipboard
var duration: Duration?

Set the interval size in minutes. Range from 0 to 1439

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

Specifies the external station/stop ID for which the arrivals/departures shall be retrieved. Required if id is not present

filterEquiv
Link copied to clipboard
var filterEquiv: Boolean?

Enables/disables the filtering of equivalent marked stops

id
Link copied to clipboard
var id: String?

Specifies the station/stop ID for which the arrivals/departures shall be retrieved. Required if extId is not present

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

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

maxJourneys
Link copied to clipboard
var maxJourneys: Int?

Maximum number of journeys to be returned. If no value is defined or -1, all departing/arriving services within the duration sized period are returned

operators
Link copied to clipboard
var operators: HapiFilterList?

Only journeys 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

passlist
Link copied to clipboard
var passlist: Boolean?

Include a list of all passed waystops?

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

Filter boards by platform. Multiple platforms are separated by comma

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: String?

Set the realtime mode to be used if enabled

size
Link copied to clipboard
open override val size: Int
time
Link copied to clipboard
var time: LocalTime?

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

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