Home › vocab › hafas

HAFAS (transport.rest) vocabulary

The fields of the JSON that transport.rest (hafas-rest-api over a HAFAS server) answers with, each under its upstream name, as measured on vbb. Every field upstream sends is served under one of these terms. RDF: hafas.ttl

adminCode — administration code
The code of the company that administers the line in HAFAS.
arrivals — arrival
One arrival on the board, in time order.
bg — background colour
The line's background colour, as a hex code.
bus — bus
Whether buses serve the stop.
categories — category
A category number of a warning.
code — code
The code of a hint.
color — colour
The line's colours.
company — company
The company a warning comes from.
currentTripPosition — current trip position
Where the vehicle is now, where the server knows it.
delay — delay
The predicted delay in seconds; absent without realtime data.
departures — departure
One departure on the board, in time order.
destination — destination
The last stop of the run.
direction — direction
The destination shown on the vehicle.
distance — distance
Straight-line distance from the point searched around, in metres.
express — express
Whether long-distance trains serve the stop.
fahrtNr — run number
The operator's number of the run (Fahrtnummer).
ferry — ferry
Whether ferries serve the stop.
fg — foreground colour
The line's text colour, as a hex code.
icon — icon
The icon the server shows with a warning.
id — id
The server's id of the thing; for a stop or station its HAFAS number (900100003), which names it in this wrapper's URIs.
ids — ids
Other ids of the stop.
ifopt — IFOPT id
The stop's DHID (IFOPT, de:11000:900100003), the nationwide id EFA servers name stops by.
latitude — latitude
Latitude in WGS84 degrees.
line — line
The line the vehicle runs on.
location — location
Where a place is: latitude and longitude in WGS84; also served as the owner's GeoSPARQL point (geo:hasGeometry).
locations — location
A stop the search found, in the server's order. Not an upstream field: the members of the bare array that locations and locations/nearby answer.
longitude — longitude
Longitude in WGS84 degrees.
mode — mode
The mode of transport (train, bus, watercraft, ...).
modified — modified
When a warning was last changed.
name — name
The name as the server gives it.
operator — operator
The company that runs the line.
origin — origin
The first stop of the run.
plannedPlatform — planned platform
The platform in the timetable.
plannedWhen — planned time
The time in the timetable.
platform — platform
The platform the event happens at, as predicted.
priority — priority
The priority of a warning.
product — product
The product the line belongs to, one of the products of a stop (suburban, subway, tram, bus, ferry, express, regional).
productName — product name
The product as shown (S, U, Bus, RE, ...).
products — products
Which products serve the stop.
prognosisType — prognosis type
Where the prediction comes from (prognosed, calculated, ...).
provenance — provenance
On an arrival board, where the vehicle comes from, as shown.
public — public
Whether the line is open to the public.
realtimeDataUpdatedAt — realtime data updated at
When the server last received realtime data, as Unix seconds.
regional — regional
Whether regional trains serve the stop.
remarks — remark
A note on the event: a hint (bicycles, accessibility) or a warning (a disruption).
stationDHID — station DHID
The DHID of the station a stop belongs to.
stop — stop
The stop or platform the event happens at.
stops — stop
A stop that belongs to a station.
suburban — suburban
Whether S-Bahn trains serve the stop.
subway — subway
Whether U-Bahn trains serve the stop.
summary — summary
The short title of a warning.
text — text
The text of a remark.
title — title
The title of an icon.
tram — tram
Whether trams serve the stop.
tripId — trip id
The server's id of the vehicle's run; valid for a few days only.
type — type
The server's kind of the object: stop, station, location for places; line, operator; hint, warning for remarks.
validFrom — valid from
When a warning starts to apply.
validUntil — valid until
When a warning stops applying.
when — time
The predicted time where the server has realtime data, else the planned time; absent for a cancelled event.

Term definitions licensed CC BY 4.0. The fields they describe are those of the EFA rapidJSON interface, as measured.