Get all situations active for the authority.
Time constraints for booking
Who should ticket be contacted for booking
How should service be booked?
Textual description of booking arrangement for service
How many days prior to the travel the service needs to be booked
Latest time the service can be booked. ISO 8601 timestamp
Minimum period in advance service can be booked as a ISO 8601 duration
Description of branding.
URL to an image be used for branding
Full name to be used for branding.
Short name to be used for branding.
URL to be used for branding
Name of person to contact
Email adress for contact
Textual description of how to get in contact
Phone number for contact
Url for contact
A planned journey on a specific day
The date this service runs. The date used is based on the service date as opposed to calendar date.
List of the dated service journeys this dated service journeys replaces
The service journey this Dated Service Journey is based on
Alterations specified on the Trip in the planned data
An advertised destination of a specific journey pattern, usually displayed on a head sign or at other on-board locations.
List of visits to quays as part of vehicle journeys. Updated with real time information where available
Actual time of arrival at quay. Updated from real time information if available. NOT IMPLEMENTED
Actual time of departure from quay. Updated with real time information if available. NOT IMPLEMENTED
Scheduled time of arrival at quay. Not affected by read time updated
Scheduled time of departure from quay. Not affected by read time updated
Booking arrangements for this EstimatedCall.
Whether stop is cancelled. This means that either the ServiceJourney has a planned cancellation, the ServiceJourney has been cancelled by realtime data, or this particular StopPoint has been cancelled. This also means that both boarding and alighting has been cancelled.
The date the estimated call is valid for.
Expected time of arrival at quay. Updated with real time information if available. Will be null if an actualArrivalTime exists
Expected time of departure from quay. Updated with real time information if available. Will be null if an actualDepartureTime exists
Whether vehicle may be alighted at quay according to the planned data. If the cancellation flag is set, alighting is not possible, even if this field is set to true.
Whether vehicle may be boarded at quay according to the planned data. If the cancellation flag is set, boarding is not possible, even if this field is set to true.
Whether the updated estimates are expected to be inaccurate. NOT IMPLEMENTED
Whether this call has been updated with real time information.
Whether vehicle will only stop on request.
Get all relevant situations for this EstimatedCall.
Whether this is a timing point or not. Boarding and alighting is not allowed at timing points.
Additional (optional) grouping of lines for particular purposes such as e.g. fare harmonisation or public presentation.
Description of group of lines
Full name for group of lines.
For internal use by operator/authority.
Short name for group of lines.
Filter trips by disallowing lines involving certain elements. If both lines and authorities are specified, only one must be valid for each line to be banned. If a line is both banned and whitelisted, it will be counted as banned.
Set of ids for authorities that should not be used
Set of ids for lines that should not be used
NOT IMPLEMENTED. Set of ids of quays that should not be allowed for boarding or alighting. Trip patterns that travel through the quay will still be permitted.
NOT IMPLEMENTED. Set of ids of quays that should not be allowed for boarding, alighting or traveling thorugh.
Set of ids of service journeys that should not be used.
Input type for coordinates in the WGS84 system
Bike parks to include by id.
Bike rentals to include by id.
Car parks to include by id.
Lines to include by id.
Quays to include by id.
Filter trips by only allowing lines involving certain elements. If both lines and authorities are specified, only one must be valid for each line to be used. If a line is both banned and whitelisted, it will be counted as banned.
Set of ids for authorities that should be used
Set of ids for lines that should be used
Maximum time after scheduled departure time the connecting transport is guarantied to wait for the delayed trip. [NOT RESPECTED DURING ROUTING, JUST PASSED THROUGH]
The transfer priority is used to decide where a transfer should happen, at the highest prioritized location. If the guarantied flag is set it take precedence priority. A guarantied ALLOWED transfer is preferred over a PREFERRED none-guarantied transfer.
Parameters for the OTP Itinerary Filter Chain. These parameters SHOULD be configured on the server side and should not be used by the client. They are made available here to be able to experiment and tune the server.
Pick ONE itinerary from each group after putting itineraries that is 85% similar together.
Reduce the number of itineraries in each group to to maximum 3 itineraries. The itineraries are grouped by similar legs (on board same journey). So, if 68% of the distance is traveled by similar legs, then two itineraries are in the same group. Default value is 68%, must be at least 50%.
Of the itineraries grouped to maximum of three itineraries, how much worse can the non-grouped legs be compared to the lowest cost. 2.0 means that they can be double the cost, and any itineraries having a higher cost will be filtered. Default value is 2.0, use a value lower than 1.0 to turn off
Set a relative limit for all transit itineraries. The limit is calculated based on the best transit itinerary generalized-cost. Itineraries without transit legs are excluded from this filter. Example: f(x) = 3600 + 2.0 x. If the lowest cost returned is 10 000, then the limit is set to: 3 600 + 2 * 10 000 = 26 600. Then all itineraries with at least one transit leg and a cost above 26 600 is removed from the result. Default: 3600.0 + 2.5 x
Quays visited by service journeys for this journey patterns
List of service journeys for the journey pattern for a given date
Get all situations active for the journey pattern.
Part of a trip pattern. Either a ride on a public transport vehicle or access or path link to/from/between places
The aimed date and time this leg ends.
The aimed date and time this leg starts.
For ride legs, the service authority used for this legs. For non-ride legs, null.
The dated service journey used for this leg.
NOT IMPLEMENTED
The distance traveled while traversing the leg in meters.
The leg's duration in seconds
The expected, realtime adjusted date and time this leg ends.
The expected, realtime adjusted date and time this leg starts.
EstimatedCall for the quay where the leg originates.
The Place where the leg originates.
Generalized cost or weight of the leg. Used for debugging.
An identifier for the leg, which can be used to re-fetch the information.
For ride legs, estimated calls for quays between the Place where the leg originates and the Place where the leg ends. For non-ride legs, empty list.
For ride legs, intermediate quays between the Place where the leg originates and the Place where the leg ends. For non-ride legs, empty list.
For ride legs, the line. For non-ride legs, null.
The mode of transport or access (e.g., foot) used when traversing this leg.
Fetch the next legs, which can be used to replace this leg. The replacement legs do arrive/depart from/to the same stop places. It might be necessary to change other legs in an itinerary in order to be able to ride the returned legs.
For ride legs, the operator used for this legs. For non-ride legs, null.
The leg's geometry.
Fetch the previous legs, which can be used to replace this leg. The replacement legs do arrive/depart from/to the same stop places. It might be necessary to change other legs in an itinerary in order to be able to ride the returned legs.
Whether there is real-time data about this leg
Whether this leg is with a rented bike.
Whether this leg is a ride leg or not.
For transit legs, the service date of the trip. For non-transit legs, null.
For ride legs, the service journey. For non-ride legs, null.
For ride legs, all estimated calls for the service journey. For non-ride legs, empty list.
All relevant situations for this leg
Do we continue from a specified via place
EstimatedCall for the quay where the leg ends.
The Place where the leg ends.
The transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride
Whether this leg is walking with a bike.
Part of a trip pattern. Either a ride on a public transport vehicle or access or path link to/from/between places
Part of a trip pattern. Either a ride on a public transport vehicle or access or path link to/from/between places
A group of routes which is generally known to the public by a similar name or number
Booking arrangements for flexible line.
Type of flexible line, or null if line is not flexible.
Groups of lines that line is a part of.
Publicly announced code for line, differentiating it from other lines for the same operator.
Get all situations active for the line.
Input format for specifying a location through either a place reference (id), coordinates or both. If both place and coordinates are provided the place ref will be used if found, coordinates will only be used if place is not known.
Coordinates for the location. This can be used alone or as fallback if the place id is not found.
The name of the location. This is pass-through informationand is not used in routing.
The id of an element in the OTP model. Currently supports Quay, StopPlace, multimodal StopPlace, and GroupOfStopPlaces.
Input format for specifying which modes will be allowed for this search. If this element is not present, it will default to accessMode/egressMode/directMode of foot and all transport modes will be allowed.
The mode used to get from the origin to the access stops in the transit network the transit network (first-mile). If the element is not present or null,only transit that can be immediately boarded from the origin will be used.
The mode used to get from the origin to the destination directly, without using the transit network. If the element is not present or null,direct travel without using transit will be disallowed.
The mode used to get from the egress stops in the transit network tothe destination (last-mile). If the element is not present or null,only transit that can immediately arrive at the origin will be used.
The allowed modes for the transit part of the trip. Use an empty list to disallow transit for this search. If the element is not present or null, it will default to all transport modes.
Text with language
Organisation providing public transport services.
Information about pagination in a connection.
When paginating forwards, the cursor to continue.
When paginating forwards, are there more items?
When paginating backwards, are there more items?
When paginating backwards, the cursor to continue.
A series of turn by turn instructions used for walking, biking and driving.
This step is on an open area, such as a plaza or train platform, and thus the directions should say something like "cross"
The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions
The distance in meters that this step takes.
When exiting a highway or traffic circle, the exit name/number.
The absolute direction of this step.
The latitude of the step.
The longitude of the step.
The relative direction of this step.
Indicates whether or not a street changes direction at an intersection.
The name of the street.
Common super class for all places (stop places, quays, car parks, bike parks and bike rental stations )
The bike rental station related to the place
The flexible area related to the place.
The latitude of the place.
The longitude of the place.
For transit quays, the name of the quay. For points of interest, the name of the POI.
The quay related to the place.
The rental vehicle related to the place
Type of vertex. (Normal, Bike sharing station, Bike P+R, Transit quay) Mostly used for better localization of bike sharing and P+R station names
A connection to a list of items.
a list of edges
details about this specific page
An edge in a connection
cursor marks a unique position or index into the connection
The item at the end of the edge
Interface for places, i.e. quays, stop places, parks
A list of coordinates encoded as a polyline string (see http://code.google.com/apis/maps/documentation/polylinealgorithm.html)
The number of points in the string
The encoded points of the polyline. Be aware that the string could contain escape characters that need to be accounted for. (https://www.freeformatter.com/javascript-escape.html)
Types describing common presentation properties
Simple public transport situation element
Advice of situation in all different translations available
Get affected authority for this situation element
Description of situation in all different translations available
Optional links to more information.
Priority of this situation
Authority that reported this situation
ReportType of this situation
Severity of this situation
Operator's internal id for this situation
Summary of situation in all different translations available
Period this situation is in effect
A place such as platform, stance, or quayside where passengers have access to PT vehicles.
A connection to a list of items.
a list of edges
details about this specific page
An edge in a connection
cursor marks a unique position or index into the connection
The item at the end of the edge
A place such as platform, stance, or quayside where passengers have access to PT vehicles.
A place such as platform, stance, or quayside where passengers have access to PT vehicles.
Get all authorities
Get an authority by ID
Get a single bike park based on its id
Get all bike parks
Get all bike rental stations
Get all bike rental stations
Get all bike rental stations within the specified bounding box.
Get a single dated service journey based on its id
Get all dated service journeys, matching the filters
Refetch a single leg based on its id
Get a single line based on its id
Get all lines
Get all places (quays, stop places, car parks etc. with coordinates) within the specified radius from a location. The returned type has two fields place and distance. The search is done by walking so the distance is according to the network of walkables.
Get a operator by ID
Get all operators
Get a single quay based on its id)
Get all quays
Get all quays within the specified bounding box
Get all quays within the specified walking radius from a location. The returned type has two fields quay and distance
Get default routing parameters.
Get OTP server information
Get a single service journey based on its id
Get all service journeys
Get a single situation based on its situationNumber
Get all active situations.
Get a single stopPlace based on its id)
Get all stopPlaces
Get all stop places within the specified bounding box
Input type for executing a travel search for a trip between two locations. Returns trip patterns describing suggested alternatives for the trip.
Description of the reason, why the planner did not return any results
An enum describing the reason
A textual description of why the search failed. The clients are expected to have their own translations based on the code, for user visible error messages.
An enum describing the field which should be changed, in order for the search to succeed
The default parameters used in travel searches.
The alightSlack is the minimum extra time after exiting a public transport vehicle. This is the default value used, if not overridden by the 'alightSlackList'.
List of alightSlack for a given set of modes.
Separate cost for boarding a vehicle with a bicycle, which is more difficult than on foot.
Cost to park a bike.
Time to park a bike.
Cost to drop-off a rented bike.
Time to drop-off a rented bike.
Cost to rent a bike.
Time to rent a bike.
Max bike speed along streets, in meters per second
The boardSlack is the minimum extra time to board a public transport vehicle. This is the same as the 'minimumTransferTime', except that this also apply to to the first transit leg in the trip. This is the default value used, if not overridden by the 'boardSlackList'.
List of boardSlack for a given set of modes.
The acceleration speed of an automobile, in meters per second per second.
The deceleration speed of an automobile, in meters per second per second.
Time to park a car in a park and ride, w/o taking into account driving and walking cost.
Max car speed along streets, in meters per second
Option to disable the default filtering of GTFS-RT alerts by time.
If true, the remaining weight heuristic is disabled.
What is the cost of boarding a elevator?
How long does it take to get on an elevator, on average.
What is the cost of travelling one floor on an elevator?
How long does it take to advance one floor on an elevator?
Whether to apply the ellipsoid->geoid offset to all elevations in the response.
When true, realtime updates are ignored during this search.
When true, service journeys cancelled in scheduled route data will be included during this search.
This is the maximum duration in seconds for a direct street search. This is a performance limit and should therefore be set high. Use filters to limit what is presented to the client.
The maximum slope of streets for wheelchair trips.
Maximum number of transfers returned in a trip plan.
The maximum number of itineraries to return.
Accept only paths that use transit (no street-only paths).
Penalty added for using every route that is not preferred if user set any route as preferred. We return number of seconds that we are willing to wait for preferred route.
Whether the planner should return intermediate stops lists for transit legs.
Used instead of walkReluctance for stairs.
An extra penalty added on transfers (i.e. all boardings except the first one).
A global minimum transfer time (in seconds) that specifies the minimum amount of time that must pass between exiting one transit vehicle and boarding another.
Multiplicative factor on expected turning time.
How much less bad is waiting at the beginning of the trip (replaces waitReluctance on the first boarding).
How much worse is waiting for a transit vehicle than being on a transit vehicle, as a multiplier.
This prevents unnecessary transfers by adding a cost for boarding a vehicle.
A multiplier for how bad walking is, compared to being in transit for equal lengths of time.
Max walk speed along streets, in meters per second
Whether the trip must be wheelchair accessible.
All built-in and custom scalars, mapped to their actual values
List of coordinates like: [[60.89, 11.12], [62.56, 12.10]]
Local date using the ISO 8601 format: YYYY-MM-DD. Example: 2020-05-17.
DateTime format accepting ISO 8601 dates with time zone offset.
Format: YYYY-MM-DD'T'hh:mm[:ss](Z|±01:00)
Example: 2017-04-23T18:25:43+02:00 or 2017-04-23T16:25:43Z
A linear function to calculate a value(y) based on a parameter (x): y = f(x) = a + bx. It allows setting both a constant(a) and a coefficient(b) and the use those in the computation. Format: a + b x. Example: 1800 + 2.0 x
Time using the format: HH:mm:SS. Example: 18:25:SS
Long type
Time using the format: HH:MM:SS. Example: 18:25:43
The 'configVersion' of the build-config.json file.
OTP Build timestamp
The 'configVersion' of the otp-config.json file.
The otp-serialization-version-id used to check graphs for compatibility with current version of OTP.
The 'configVersion' of the router-config.json file.
Maven version
A planned vehicle journey with passengers.
Whether bikes are allowed on service journey.
Booking arrangements for flexible services.
Returns scheduled passingTimes for this ServiceJourney for a given date, updated with realtime-updates (if available). NB! This takes a date as argument (default=today) and returns estimatedCalls for that date and should only be used if the date is known when creating the request. For fetching estimatedCalls for a given trip.leg, use leg.serviceJourneyEstimatedCalls instead.
Returns scheduled passing times only - without realtime-updates, for realtime-data use 'estimatedCalls'
Detailed path travelled by service journey. Not available for flexible trips.
For internal use by operators.
Publicly announced code for service journey, differentiating it from other service journeys for the same line.
Quays visited by service journey
Get all situations active for the service journey.
Whether service journey is accessible with wheelchair.
A planned vehicle journey with passengers.
A planned vehicle journey with passengers.
Named place where public transport may be accessed. May be a building complex (e.g. a station) or an on-street location.
Named place where public transport may be accessed. May be a building complex (e.g. a station) or an on-street location.
Named place where public transport may be accessed. May be a building complex (e.g. a station) or an on-street location.
Named place where public transport may be accessed. May be a building complex (e.g. a station) or an on-street location.
A system notice is used to tag elements with system information for debugging or other system related purpose. One use-case is to run a routing search with 'itineraryFilters.debug: true'. This will then tag itineraries instead of removing them from the result. This make it possible to inspect the itinerary-filter-chain. A SystemNotice only have english text, because the primary user are technical staff, like testers and developers.
Scheduled passing times. These are not affected by real time updates.
Scheduled time of arrival at quay
Booking arrangements for this passing time.
Scheduled time of departure from quay
Whether vehicle may be alighted at quay.
Whether vehicle may be boarded at quay.
Whether vehicle will only stop on request.
Whether this is a timing point or not. Boarding and alighting is not allowed at timing points.
Used to specify board and alight slack for a given modes.
List of modes for which the given slack apply.
The slack used for all given modes.
Used to specify board and alight slack for a given modes.
A transportMode that should be allowed for this search. You can furthernarrow it down by specifying a list of transportSubModes
The allowed transportSubModes for this search. If this element is notpresent or null, it will default to all transportSubModes for the specifiedTransportMode. Be aware that all transportSubModes have an associated TransportMode, which must match what is specified in the transportMode field.
How much the factors safety, slope and distance are weighted relative to each other when routing bicycle legs. In total all three values need to add up to 1.
How important is bicycle safety expressed as a fraction of 1.
How important is slope/elevation expressed as a fraction of 1.
How important is time expressed as a fraction of 1. Note that what this really optimises for is distance (even if that means going over terrible surfaces, so I might be slower than the safe route).
Description of a travel between two places.
The time and date of travel
Information about the timings for the trip generation
The origin
A list of possible error messages as enum
A list of possible error messages in cleartext
The trip request metadata.
Use the cursor to get the next page of results. Use this cursor for the pageCursor parameter in the trip query in order to get the next page. The next page is a set of itineraries departing AFTER the last itinerary in this result.
Use the cursor to get the previous page of results. Use this cursor for the pageCursor parameter in the trip query in order to get the previous page. The previous page is a set of itineraries departing BEFORE the first itinerary in this result.
A list of routing errors, and fields which caused them
The destination
A list of possible trip patterns
List of legs constituting a suggested sequence of rides and links for a specific trip.
The aimed date and time the trip ends.
The aimed date and time the trip starts.
NOT IMPLEMENTED.
Total distance for the trip, in meters. NOT IMPLEMENTED
Duration of the trip, in seconds.
Time that the trip arrives.
The expected, realtime adjusted date and time the trip ends.
The expected, realtime adjusted date and time the trip starts.
Generalized cost or weight of the itinerary. Used for debugging.
A list of legs. Each leg is either a walking (cycling, car) portion of the trip, or a ride leg on a particular vehicle. So a trip where the use walks to the Q train, transfers to the 6, then walks to their destination, has four legs.
Time that the trip departs.
Get all system notices.
A cost calculated to favor transfer with higher priority. This field is meant for debugging only.
A cost calculated to distribute wait-time and avoid very short transfers. This field is meant for debugging only.
How much time is spent waiting for transit to arrive, in seconds.
How far the user has to walk, in meters.
How much time is spent walking, in seconds.
Trips search metadata.
This is the suggested search time for the "next page" or time window. Insert it together with the 'searchWindowUsed' in the request to get a new set of trips following in the time-window AFTER the current search.
This is the suggested search time for the "previous page" or time-window. Insert it together with the 'searchWindowUsed' in the request to get a new set of trips preceding in the time-window BEFORE the current search.
This is the time window used by the raptor search. The input searchWindow is an optional parameter and is dynamically assigned if not set. OTP might override the value if it is too small or too large. When paging OTP adjusts it to the appropriate size, depending on the number of itineraries found in the current search window. The scaling of the search window ensures faster paging and limits resource usage. The unit is seconds.
Generated using TypeDoc
Authority involved in public transportation. An organisation under which the responsibility of organising the transport service in a certain area is placed.