Package de.jlnstrk.transit.api.hapi.model

Types

HapiAffectedStop

data class HapiAffectedStop(StopLocation: List<HapiStopLocation>)

HapiArrival

data class HapiArrival(name: String, type: HapiLocationType, stop: String, stopid: String, stopExtId: String?, prognosisType: HafasPrognosisType?, time: LocalTime, scheduledTimeChanged: Boolean, date: LocalDate, tz: ZoneOffset, track: String?, rtTime: LocalTime?, rtDate: LocalDate?, rtTz: ZoneOffset, rtTrack: String?, cancelled: Boolean, partCancelled: Boolean, reachable: Boolean, redirected: Boolean, origin: String?, isBorderStop: Boolean, entry: Boolean?, JourneyDetailRef: String, JourneyStatus: HapiJourneyStatus?, Product: List<HapiProduct>, Notes: List<HapiNote>, Messages: List<HapiMessage>, altId: List<String>, Stops: List<HapiStop>, Occupancy: List<HapiOccupancy>)

The element Arrival contains all information about a arrival like time, date, stop/station name, track, realtime time, date and track, origin, name and type of the journey. It also contains a reference to journey details.

HapiBooleanPair

data class HapiBooleanPair(name: String, value: Boolean)

HapiCalculationType

enum HapiCalculationType : Enum<HapiCalculationType>

Indicates whether the connection originated from the initial search using the original parameters, or from a retried search with changed parameters that was performed after the initial search failed.

HapiColor

data class HapiColor(r: Int, g: Int, b: Int, alpha: Int?, hex: String)

HapiCoord

data class HapiCoord(lon: Double, lat: Double, alt: Double?)

HapiDeparture

data class HapiDeparture(name: String, type: HapiLocationType, stop: String, stopid: String, stopExtId: String?, prognosisType: HafasPrognosisType?, time: LocalTime, scheduledTimeChanged: Boolean, date: LocalDate, tz: ZoneOffset, track: String?, rtTime: LocalTime?, rtDate: LocalDate?, rtTz: ZoneOffset, rtTrack: String?, cancelled: Boolean, partCancelled: Boolean, reachable: Boolean, redirected: Boolean, direction: String?, timeAtArrival: LocalTime?, dateAtArrival: LocalDate?, rtTimeAtArrival: LocalTime?, rtDateAtArrival: LocalDate?, isFastest: Boolean?, isBorderStop: Boolean, entry: Boolean?, JourneyDetailRef: String, JourneyStatus: HapiJourneyStatus?, Product: List<HapiProduct>, Notes: List<HapiNote>, Messages: List<HapiMessage>, altId: List<String>, Stops: List<HapiStop>, Occupancy: List<HapiOccupancy>)

The element Departure contains all information about a departure like time, date, stop/station name, track, realtime time, date and track, direction, name and type of the journey. It also contains a reference to journey details.

HapiDirection

data class HapiDirection(routeIdxFrom: Int, routeIdxTo: Int)

Direction information. This is usually the last stop of the journey.

HapiEco

data class HapiEco(co2: Double, do2f: Double, part: Double, part10: Double, partV: Double, nmhc: Double, nox: Double, prime: Double, primef: Double, so2: Double, ubp: Double, dist: Int, type: HapiEco.Type)

HapiFrequency

data class HapiFrequency(journey: List<HapiJourney>, waitMinimum: Duration?, waitMaximum: Duration?, alternativeCount: Int?)

Alternatives for this leg by plan.

HapiIcon

data class HapiIcon(foregroundColor: HapiColor?, backgroundColor: HapiColor?, borderColor: HapiColor?, res: String, txt: String?, txtS: String?, style: HapiIcon.Style?, shape: HapiIcon.Shape?, shapeRes: String?)

HapiJourneyDetailGroup

data class HapiJourneyDetailGroup(JourneyDetail: List<HapiJourneyDetail>, name: String?, nameS: String?)

A group of detailed journeys.

HapiMessage

data class HapiMessage(id: String, externalId: String?, act: Boolean, head: String, lead: String?, text: String, customText: String?, tckr: String?, company: String?, category: String?, priority: Int, products: Int?, icon: String?, routeIdxFrom: Int?, routeIdxTo: Int?, sTime: LocalTime?, sDate: LocalDate?, eTime: LocalTime?, eDate: LocalDate?, altStart: String?, altEnd: String?, modTime: LocalTime?, modDate: LocalDate?, affectedProduct: List<HapiProduct>, affectedJourney: List<HapiJourney>, edge: List<HapiMessage.Edge>, region: List<HapiMessage.Region>, affectedStops: List<HapiAffectedStop>, validFromStop: HapiStop?, validToStop: HapiStop?, tags: List<String>, channel: List<HapiMessage.Channel>, messageCategory: List<HapiMessage.Category>, messageText: List<HapiMessage.Text>, Note: List<HapiNote>, message: List<HapiMessage>)

HapiName

data class HapiName(name: String, number: String, category: String, routeIdxFrom: Int, routeIdxTo: Int, Product: HapiProduct?)

Contains name of journey.

HapiNote

data class HapiNote(value: String, key: HafasRemarkCode?, type: HafasRemarkType?, priority: Int, routeIdxFrom: Int?, routeIdxTo: Int?, txtN: String?, txtL: String?, txtS: String?)

Contains a text with notes to be displayed for this leg, like attributes or footnotes.

HapiOccupancy

data class HapiOccupancy(name: String?, v: Int, number: Int?, raw: Int?)

Occupancy information

HapiOperator

data class HapiOperator(administration: List<String>, name: String, nameS: String?, nameN: String?, nameL: String?, addName: String?, id: String?)

Operator info.

HapiPair

data class HapiPair(key: String, value: String)

HapiPolyline

data class HapiPolyline(crd: List<Double>, name: String?, delta: Boolean, dim: Int, type: HapiCoord.Type, crdEncYX: String?, crdEncZ: String?, crdEncS: String?)

Describes a polyline structure

HapiPolylineDescription

typealias HapiPolylineDescription = HapiPolyline

HapiPolylineGroup

data class HapiPolylineGroup(polylineDesc: List<HapiPolyline>, name: String?, coordType: HapiCoord.Type, layerName: String?)

HapiProduct

data class HapiProduct(name: String?, internalName: String?, addName: String?, displayNumber: String?, num: String?, line: String?, lineId: String?, catOut: String?, catIn: String?, catCode: String?, cls: Int?, catOutS: String?, catOutL: String?, operatorCode: String?, operator: String?, admin: String?, routeIdxFrom: Int?, routeIdxTo: Int?, matchId: String?, icon: HapiIcon?, status: HapiProduct.Status?)

Product context, provides access to internal data. For the product category attributes, their assignments are defined in the "zugart" file from the raw Hafas plan data.

HapiProductCategory

data class HapiProductCategory(Product: List<HapiProduct>, name: String, cls: String?)

Product category info.

HapiResourceLink

data class HapiResourceLink(rel: String, href: String)

HapiServiceDays

data class HapiServiceDays(planningPeriodBegin: LocalDate?, planningPeriodEnd: LocalDate?, sDaysR: String?, sDaysI: String?, sDaysB: String?, routeIdxFrom: Int?, routeIdxTo: Int?)

HapiTimetableInfo

data class HapiTimetableInfo(date: LocalDate, time: LocalTime, ident: String, type: HapiTimetableInfo.Type, begin: LocalDate, end: LocalDate)

HapiUrlLink

data class HapiUrlLink(name: String?, url: String)