The OpenTripPlanner multimodal journey planning system
The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.
| name | path | methods | description |
|---|---|---|---|
| AlertPatcher |
|
|
|
| BikeRental |
|
|
|
| CarRental |
|
|
|
| ExternalGeocoderResource |
|
|
Maybe the internal geocoder resource should just chain to defined external geocoders? |
| GeocoderResource |
|
|
OTP simple built-in geocoder. Client geocoder modules usually read XML, but GeocoderBuiltin reads JSON. |
| GraphInspectorTileResource |
|
|
Slippy map tile API for rendering various graph information for inspection/debugging purpose
(bike safety factor, connectivity...).
One can easily add a new layer by adding the following kind of code to a leaflet map:
var bikesafety = new L.TileLayer(
'http://localhost:8080/otp/routers/default/inspector/tile/bike-safety/{z}/{x}/{y}.png',
{ maxZoom : 22 });
var map = L.map(...);
L.control.layers(null, { "Bike safety": bikesafety }).addTo(map);
Tile rendering goes through TileRendererManager which select the appropriate renderer for the
given layer.
|
| IndexAPI |
|
|
|
| LIsochrone |
|
|
Return isochrone geometry as a set of GeoJSON or zipped-shapefile multi-polygons.
Example of request:
http://localhost:8080/otp-rest-servlet/ws/isochrone?routerId=bordeaux&algorithm=accSampling&fromPlace=47.059,-0.880&date=2013/10/01&time=12:00:00&maxWalkDistance=1000&mode=WALK,TRANSIT&cutoffSec=1800&cutoffSec=3600
|
| LegendResource |
|
|
|
| MunicoderServer |
|
|
|
| ParkAndRide |
|
|
Created by demory on 7/26/18. |
| PlannerResource |
|
|
This is the primary entry point for the trip planning web service. All parameters are passed in the query string. These parameters are defined as fields in the abstract RoutingResource superclass, which also has methods for building routing requests from query parameters. This allows multiple web services to have the same set of query parameters. In order for inheritance to work, the REST resources are request-scoped (constructed at each request) rather than singleton-scoped (a single instance existing for the lifetime of the OTP server). |
| PointSetResource |
|
|
This Jersey REST Resource creates and lists PointSets. PointSets serve as destinations in web analyst one-to-many indicators. They can also serve as origins in many-to-many indicators. PointSets are one of the three main web analyst resources: Pointsets Indicators TimeSurfaces |
| ProfileResource |
|
|
A Jersey resource class which exposes OTP profile routing functionality as a web service. |
| RepeatedRaptorTestResource |
|
|
For debugging |
| Routers |
|
|
This REST API endpoint allows remotely loading, reloading, and evicting graphs on a running server. A GraphService maintains a mapping between routerIds and specific Graph objects. The HTTP verbs are used as follows to manipulate that mapping: GET - see the registered routerIds and Graphs, verify whether a particular routerId is registered PUT - create or replace a mapping from a routerId to a Graph loaded from the server filesystem POST - create or replace a mapping from a routerId to a serialized Graph sent in the request DELETE - de-register a routerId, releasing the reference to the associated graph The HTTP request URLs are of the form /ws/routers/{routerId}, where the routerId is optional. If a routerId is supplied in the URL, the verb will act upon the mapping for that specific routerId. If no routerId is given, the verb will act upon all routerIds currently registered. For example: GET http://localhost/otp-rest-servlet/ws/routers will retrieve a list of all registered routerId -> Graph mappings and their geographic bounds. GET http://localhost/otp-rest-servlet/ws/routers/london will return status code 200 and a brief description of the 'london' graph including geographic bounds, or 404 if the 'london' routerId is not registered. PUT http://localhost/otp-rest-servlet/ws/routers will reload the graphs for all currently registered routerIds from disk. PUT http://localhost/otp-rest-servlet/ws/routers/paris will load a Graph from a sub-directory called 'paris' and associate it with the routerId 'paris'. DELETE http://localhost/otp-rest-servlet/ws/routers/paris will release the Paris Graph and de-register the 'paris' routerId. DELETE http://localhost/otp-rest-servlet/ws/routers will de-register all currently registered routerIds. The GET methods are not secured, but all other methods are secured under ROLE_ROUTERS. See documentation for individual methods for additional parameters. |
| SIsochrone |
|
|
This is the original Isochrone class provided by Stefan Steineger. Another implementation has been provided by Laurent Grégoire (isochrone2). |
| ScenarioResource |
|
|
Presents saved non-destructive transit analysis scenarios as a document tree for manipulation via HTTP. |
| ScriptResource |
|
|
Run an uploaded script. This is unsafe, enable it with care. TODO Enable role-based permissions. |
| ServerInfo |
|
|
|
| SimpleIsochrone |
|
|
This class provides a vector isochrone generator for places without good OSM street connectivity, or for graphs that are too large-scale to bother with modeling streets (e.g. all of China). It assumes constant speed through both streets and "free space" around vertices, yielding isochrones that are the union of many circles. The origin snapping option used here (connect to all stations within M meters of a lat/lon) should be made into a standard query option in OTP. Instead of specifying an origin station search radius, it could be more coherent to use all stations within (maxIsochroneTime * speed) meters, and apply a travel time to reach them. The GET methods both use makeContours which in turn uses makePoints (where range checking occurs). Putting "@Setter" on all the parameters would allow resource classes to be used outside Jersey. |
| SurfaceResource |
|
|
Surfaces cannot be isolated per-router because sometimes you want to compare two surfaces from different router IDs. Though one could question whether that really makes sense (perhaps alternative scenarios should be "within" the same router) |
| TileService |
|
|
NOTE This way of fetching travel time tiles does not currently work. It relied on an SPT cache which would find existing SPTs based on search request parameters. Server side stored search results are now done explicitly with TimeSurfaces. See org.opentripplanner.api.resource.SurfaceResource, functions createSurface and tileGet The basic idea is to create a surface for a "batch" or one-to-many OTP search, then using the returned ID fetch the tiles from a URL under that surface ID. |
| TimeGridWs |
|
|
A Jersey web service resource class that returns a grid with time for a set of points.
Example of request:
http://localhost:8080/otp/routers/bordeaux/timegrid?fromPlace=47.059,-0.880&date=2013/10/01&time=12:00:00&maxWalkDistance=1000&maxTimeSec=3600&mode=WALK,TRANSIT
|
| TransportationNetworkCompanyResource |
|
|
|
| UpdaterStatusResource |
|
|
Report the status of the graph updaters via a web service. |
| VehicleRental |
|
|
An endpoint for retrieving vehicle rental data. This currently only fetches data that has been added by a "vehicle-rental" updater. TODO: refactor and combine with car and bike rental endpoints. |
| WalkComfort |
|
|
Created by demory on 11/21/17. |
| type | description |
|---|---|
| AbsoluteDirection | An absolute cardinal or intermediate direction. |
| Alert | |
| AlertPatch | This adds a note to all boardings of a given route or stop (optionally, in a given direction) |
| AlertPatchCreationResponse | |
| AlertPatchResponse | |
| AlertPatchSet | |
| ArrivalTime | |
| BikeRentalStation | |
| BikeRentalStationList | |
| BoardAlightType | Distinguish between special ways a passenger may board or alight at a stop. The majority of boardings and alightings will be of type "default" -- a regular boarding or alighting at a regular transit stop. Currently, the only non-default types are related to GTFS-Flex, but this pattern can be extended as necessary. |
| CarFuelType | |
| CarRentalStation | |
| CarRentalStationList | |
| Coordinate | |
| CoordinateArrayListSequence | An instance of CoordinateSequence that can be efficiently extended |
| CoordinateSequence | |
| CoordinateSequenceFactory | |
| DEFAULT | |
| DebugOutput | Holds information to be included in the REST Response for debugging and profiling purposes. startedCalculating is called in the routingContext constructor. finishedCalculating and finishedRendering are all called in PlanGenerator.generate(). finishedPrecalculating and foundPaths are called in the SPTService implementations. |
| ElevationMetadata | Contains elevation-specific metadata to be included in the response Created by demory on 2/16/17. |
| EncodedPolylineBean | A list of coordinates encoded as a string. See Encoded polyline algorithm format |
| EntryOfStringAndString | |
| Envelope | |
| Fare | Fare is a set of fares for different classes of users. |
| FareComponent | FareComponent is a sequence of routes for a particular fare. |
| FareType | |
| FeedScopedId | |
| GeocoderResult | |
| GeocoderResults | |
| Geometry | |
| GeometryFactory | |
| I18NString | This interface is used when providing translations on server side. |
| InspectorLayer | |
| InspectorLayersList | |
| Itinerary | An Itinerary is one complete way of getting from the start location to the end location. |
| Leg | One leg of a trip -- that is, a temporally continuous piece of the journey that takes place on a particular vehicle (or on foot). |
| LocalizedAlert | |
| LocalizedString | This is used to localize strings for which localization are known beforehand. Those are local names for: unanamedStreet, corner of x and y, path, bike_path etc. Translations are in src/main/resources/WayProperties_lang.properties and internals_lang.properties locale is set in request. |
| MavenVersion | |
| Message | The purpose of Messages is to read supply Message.properties to underlying calling code... The ENUM's enumerated values should be named to reflect the property names inside of Message.properties |
| Money | Fare support is very, very preliminary. |
| NonLocalizedString | This is to support strings which can't be localized. It just returns string it is given in constructor. |
| P2 | An ordered pair of objects of the same type |
| P2OfDouble | An ordered pair of objects of the same type |
| PackedCoordinateSequence | A CoordinateSequence implementation based on a packed arrays. In this implementation,
Coordinates returned by #toArray and #get are copies of the internal values. To change
the actual values, use the provided setters.
For efficiency, created Coordinate arrays are cached using a soft reference. The cache is cleared each time the coordinate sequence contents are modified through a setter method. 2009-11-25 - bdferris - This class copied from JTS (LGPL-licensed) to add Serializable to the class so that we can serialize it with our graphs |
| Place | A Place is where a journey starts or ends, or a transit stop along the way. |
| PlannerError | This API response element represents an error in trip planning. |
| Point | |
| PrecisionModel | |
| RelativeDirection | Represents a turn direction, relative to the current heading. CIRCLE_CLOCKWISE and CIRCLE_CLOCKWISE are used to represent traffic circles. |
| RentalStation | |
| Response | Represents a trip planner response, will be serialized into XML or JSON by Jersey |
| RideEstimate | |
| RouterInfo | |
| RouterList | |
| Serializable2DPackedCoordinateSequenceFactory | |
| ServerInfo | |
| T2 | An ordered pair of objects of potentially different types |
| TranslatedString | This is for translated strings for which translations are read from OSM or GTFS alerts. This can be translated street names, GTFS alerts and notes. |
| TransportationNetworkCompany | |
| TransportationNetworkCompanyResponse | |
| TransportationNetworkCompanySummary | Simplified TNC summary included with itinerary Leg. |
| TravelOption | This class is used to send to client which Travel Options are possible on this server This options are used in client "Travel by" drop down. Each travel option consist of two variables: - value is a value which is sent to the server if this is chosen ("TRANSIT, WALK", "CAR", etc.) - name is a name with which client can nicely name this option even if specific value changes ("TRANSIT", "PARKRIDE", "TRANSIT_BICYCLE", etc.) Travel options are created from org.opentripplanner.routing.graph.Graph transitModes variable and based if park & ride, bike & ride, bike sharing is supported. List itself is created in TravelOptionsMaker#makeOptions(HashSet, boolean, boolean, boolean) |
| TraverseMode | |
| TripPlan | A TripPlan is a set of ways to get from point A to point B at time T. |
| Type | |
| VehicleRentalStation | This class models a place where a rental vehicle can be returned or picked up. This class is typically used in one of 3 ways: 1. To model a docking station that may have multiple vehicles that can be rented and also parking spaces to return a rented vehicle. 2. To model a single floating vehicle that can only be picked up. 3. To model a border dropoff where the extent of vehicle rental region ends. At this point, the StreetEdge is split and a vehicle rental station is created to facilitate the dropoff of vehicles no further than the allowable dropoff area. FIXME: border dropoff stations, vertices and edges are probably not needed anymore with updated StreetEdge dropoff checks. |
| VehicleRentalStationList | |
| VertexType | Represent type of vertex, used in Place aka from, to in API for easier client side localization |
| WalkStep | Represents one instruction in walking directions. Three examples from New York City:
Turn onto Broadway from W 57th St (coming from 7th Ave):
Now, turn from Broadway onto Central Park S via Columbus Circle
Instead, go through the circle to continue on Broadway |
| WrappedCurrency | A Bean wrapper class for java.util.Currency |
| type | description |
|---|---|
| locale | |
| geometry | |
| message | The purpose of Messages is to read supply Message.properties to underlying calling code... The ENUM's enumerated values should be named to reflect the property names inside of Message.properties |
| absoluteDirection | An absolute cardinal or intermediate direction. |
| boardAlightType | Distinguish between special ways a passenger may board or alight at a stop. The majority of boardings and alightings will be of type "default" -- a regular boarding or alighting at a regular transit stop. Currently, the only non-default types are related to GTFS-Flex, but this pattern can be extended as necessary. |
| itinerary | An Itinerary is one complete way of getting from the start location to the end location. |
| leg | One leg of a trip -- that is, a temporally continuous piece of the journey that takes place on a particular vehicle (or on foot). |
| place | A Place is where a journey starts or ends, or a transit stop along the way. |
| relativeDirection | Represents a turn direction, relative to the current heading. CIRCLE_CLOCKWISE and CIRCLE_CLOCKWISE are used to represent traffic circles. |
| routerInfo | |
| routerList | |
| transportationNetworkCompanyResponse | |
| transportationNetworkCompanySummary | Simplified TNC summary included with itinerary Leg. |
| tripPlan | A TripPlan is a set of ways to get from point A to point B at time T. |
| vertexType | Represent type of vertex, used in Place aka from, to in API for easier client side localization |
| walkStep | Represents one instruction in walking directions. Three examples from New York City:
Turn onto Broadway from W 57th St (coming from 7th Ave):
Now, turn from Broadway onto Central Park S via Columbus Circle
Instead, go through the circle to continue on Broadway |
| alertPatchCreationResponse | |
| alertPatchResponse | |
| alertPatchSet | |
| localizedAlert | |
| plannerError | This API response element represents an error in trip planning. |
| bikeRentalStationList | |
| carRentalStationList | |
| debugOutput | Holds information to be included in the REST Response for debugging and profiling purposes. startedCalculating is called in the routingContext constructor. finishedCalculating and finishedRendering are all called in PlanGenerator.generate(). finishedPrecalculating and foundPaths are called in the SPTService implementations. |
| elevationMetadata | Contains elevation-specific metadata to be included in the response Created by demory on 2/16/17. |
| inspectorLayersList | |
| inspectorLayer | |
| response | Represents a trip planner response, will be serialized into XML or JSON by Jersey |
| serverInfo | |
| vehicleRentalStationList | |
| mavenVersion | |
| p2 | An ordered pair of objects of the same type |
| t2 | An ordered pair of objects of potentially different types |
| feedScopedId | |
| alert | |
| alertPatch | This adds a note to all boardings of a given route or stop (optionally, in a given direction) |
| bikeRentalStation | |
| carFuelType | |
| carRentalStation | |
| fare | Fare is a set of fares for different classes of users. |
| fareType | |
| fareComponent | FareComponent is a sequence of routes for a particular fare. |
| money | Fare support is very, very preliminary. |
| TraverseMode | |
| wrappedCurrency | A Bean wrapper class for java.util.Currency |
| arrivalTime | |
| rideEstimate | |
| transportationNetworkCompany | |
| rentalStation | |
| vehicleRentalStation | This class models a place where a rental vehicle can be returned or picked up. This class is typically used in one of 3 ways: 1. To model a docking station that may have multiple vehicles that can be rented and also parking spaces to return a rented vehicle. 2. To model a single floating vehicle that can only be picked up. 3. To model a border dropoff where the extent of vehicle rental region ends. At this point, the StreetEdge is split and a vehicle rental station is created to facilitate the dropoff of vehicles no further than the allowable dropoff area. FIXME: border dropoff stations, vertices and edges are probably not needed anymore with updated StreetEdge dropoff checks. |
| i18NString | This interface is used when providing translations on server side. |
| localizedString | This is used to localize strings for which localization are known beforehand. Those are local names for: unanamedStreet, corner of x and y, path, bike_path etc. Translations are in src/main/resources/WayProperties_lang.properties and internals_lang.properties locale is set in request. |
| nonLocalizedString | This is to support strings which can't be localized. It just returns string it is given in constructor. |
| translatedString | This is for translated strings for which translations are read from OSM or GTFS alerts. This can be translated street names, GTFS alerts and notes. |
| travelOption | This class is used to send to client which Travel Options are possible on this server This options are used in client "Travel by" drop down. Each travel option consist of two variables: - value is a value which is sent to the server if this is chosen ("TRANSIT, WALK", "CAR", etc.) - name is a name with which client can nicely name this option even if specific value changes ("TRANSIT", "PARKRIDE", "TRANSIT_BICYCLE", etc.) Travel options are created from org.opentripplanner.routing.graph.Graph transitModes variable and based if park & ride, bike & ride, bike sharing is supported. List itself is created in TravelOptionsMaker#makeOptions(HashSet, boolean, boolean, boolean) |
| encodedPolylineBean | A list of coordinates encoded as a string. See Encoded polyline algorithm format |