org.opentripplanner.index

Class IndexAPI

java.lang.Object

org.opentripplanner.index.IndexAPI

@Path(value="/routers/{routerId}/index")
 @Produces(value="application/json")
public class IndexAPI
extends Object

Constructor Summary

Constructors

Constructor and Description
IndexAPI(OTPServer otpServer, String routerId)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAgencies(String feedId) Return a list of all agencies in the graph.
javax.ws.rs.core.Response	getAgency(String feedId, String agencyId) Return specific agency in the graph, by ID.
javax.ws.rs.core.Response	getAgencyRoutes(String feedId, String agencyId) Return all routes for the specific agency.
javax.ws.rs.core.Response	getAllFlexAreas() Return all GTFS-Flex area IDs.
javax.ws.rs.core.Response	getAllStopClusters() Return all clusters of stops.
javax.ws.rs.core.Response	getFeedInfo(String feedId)
javax.ws.rs.core.Response	getFeeds()
javax.ws.rs.core.Response	getFlexAreaByFeedId(String areaIdString) Return a specific GTFS-Flex area given an ID in Agency:ID format.
javax.ws.rs.core.Response	getGeometryForPattern(String patternIdString) Return geometry for the pattern as a packed coordinate sequence
javax.ws.rs.core.Response	getGeometryForTrip(String tripIdString) Return geometry for the trip as a packed coordinate sequence
javax.ws.rs.core.Response	getGraphQL(HashMap<String,Object> queryParameters)
javax.ws.rs.core.Response	getGraphQL(String query)
javax.ws.rs.core.Response	getPattern(String patternIdString)
javax.ws.rs.core.Response	getPatterns()
javax.ws.rs.core.Response	getPatternsForRoute(String routeIdString) Return all stop patterns used by trips on the given route.
javax.ws.rs.core.Response	getPatternsForStop(String stopIdString)
javax.ws.rs.core.Response	getRoute(String routeIdString) Return specific route in the graph, for the given ID.
javax.ws.rs.core.Response	getRoutes(List<String> stopIds) Return a list of all routes in the graph.
javax.ws.rs.core.Response	getRoutesForStop(String stopId)
javax.ws.rs.core.Response	getSemanticHashForPattern(String patternIdString)
javax.ws.rs.core.Response	getSemanticHashForTrip(String tripIdString)
javax.ws.rs.core.Response	getServices() List basic information about all service IDs.
javax.ws.rs.core.Response	getServices(String serviceId) List details about a specific service ID including which dates it runs on.
javax.ws.rs.core.Response	getStop(String stopIdString) Return specific transit stop in the graph, by ID.
javax.ws.rs.core.Response	getStopCluster(String clusterIdString) Return a cluster of stops by its ID.
javax.ws.rs.core.Response	getStopsForPattern(String patternIdString)
javax.ws.rs.core.Response	getStopsForRoute(String routeIdString) Return all stops in any pattern on a given route.
javax.ws.rs.core.Response	getStopsForTrip(String tripIdString)
javax.ws.rs.core.Response	getStopsInRadius(Double minLat, Double minLon, Double maxLat, Double maxLon, Double lat, Double lon, Double radius) Return a list of all stops within a circle around the given coordinate.
javax.ws.rs.core.Response	getStoptimesForStop(String stopIdString, long startTime, int timeRange, int numberOfDepartures, boolean omitNonPickups) Return upcoming vehicle arrival/departure times at the given stop.
javax.ws.rs.core.Response	getStoptimesForStopAndDate(String stopIdString, String date, boolean omitNonPickups) Return upcoming vehicle arrival/departure times at the given stop.
javax.ws.rs.core.Response	getStoptimesForTrip(String tripIdString)
javax.ws.rs.core.Response	getTransfers(String stopIdString) Return the generated transfers a stop in the graph, by stop ID
javax.ws.rs.core.Response	getTrip(String tripIdString)
javax.ws.rs.core.Response	getTripsForPattern(String patternIdString)
javax.ws.rs.core.Response	getTripsForRoute(String routeIdString) Return all trips in any pattern on the given route.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexAPI

public IndexAPI(@Context
                OTPServer otpServer,
                @PathParam(value="routerId")
                String routerId)

Method Detail

getFeeds

@GET
 @Path(value="/feeds")
public javax.ws.rs.core.Response getFeeds()

getFeedInfo

@GET
 @Path(value="/feeds/{feedId}")
public javax.ws.rs.core.Response getFeedInfo(@PathParam(value="feedId")
                                                                                  String feedId)

getAgencies

@GET
 @Path(value="/agencies/{feedId}")
public javax.ws.rs.core.Response getAgencies(@PathParam(value="feedId")
                                                                                     String feedId)

Return a list of all agencies in the graph.

getAgency

@GET
 @Path(value="/agencies/{feedId}/{agencyId}")
public javax.ws.rs.core.Response getAgency(@PathParam(value="feedId")
                                                                                              String feedId,
                                                                                              @PathParam(value="agencyId")
                                                                                              String agencyId)

Return specific agency in the graph, by ID.

getAgencyRoutes

@GET
 @Path(value="/agencies/{feedId}/{agencyId}/routes")
public javax.ws.rs.core.Response getAgencyRoutes(@PathParam(value="feedId")
                                                                                                           String feedId,
                                                                                                           @PathParam(value="agencyId")
                                                                                                           String agencyId)

Return all routes for the specific agency.

getStop

@GET
 @Path(value="/stops/{stopId}")
public javax.ws.rs.core.Response getStop(@PathParam(value="stopId")
                                                                              String stopIdString)

Return specific transit stop in the graph, by ID.

getStopsInRadius

@GET
 @Path(value="/stops")
public javax.ws.rs.core.Response getStopsInRadius(@QueryParam(value="minLat")
                                                                              Double minLat,
                                                                              @QueryParam(value="minLon")
                                                                              Double minLon,
                                                                              @QueryParam(value="maxLat")
                                                                              Double maxLat,
                                                                              @QueryParam(value="maxLon")
                                                                              Double maxLon,
                                                                              @QueryParam(value="lat")
                                                                              Double lat,
                                                                              @QueryParam(value="lon")
                                                                              Double lon,
                                                                              @QueryParam(value="radius")
                                                                              Double radius)

Return a list of all stops within a circle around the given coordinate.

getRoutesForStop

@GET
 @Path(value="/stops/{stopId}/routes")
public javax.ws.rs.core.Response getRoutesForStop(@PathParam(value="stopId")
                                                                                              String stopId)

getPatternsForStop

@GET
 @Path(value="/stops/{stopId}/patterns")
public javax.ws.rs.core.Response getPatternsForStop(@PathParam(value="stopId")
                                                                                                  String stopIdString)

getStoptimesForStop

@GET
 @Path(value="/stops/{stopId}/stoptimes")
public javax.ws.rs.core.Response getStoptimesForStop(@PathParam(value="stopId")
                                                                                                    String stopIdString,
                                                                                                    @QueryParam(value="startTime")
                                                                                                    long startTime,
                                                                                                    @QueryParam(value="timeRange") @DefaultValue(value="86400")
                                                                                                    int timeRange,
                                                                                                    @QueryParam(value="numberOfDepartures") @DefaultValue(value="2")
                                                                                                    int numberOfDepartures,
                                                                                                    @QueryParam(value="omitNonPickups")
                                                                                                    boolean omitNonPickups)

Return upcoming vehicle arrival/departure times at the given stop.

Parameters:

stopIdString - Stop ID in Agency:Stop ID format

startTime - Start time for the search. Seconds from UNIX epoch

timeRange - Searches forward for timeRange seconds from startTime

numberOfDepartures - Number of departures to fetch per pattern

getStoptimesForStopAndDate

@GET
 @Path(value="/stops/{stopId}/stoptimes/{date}")
public javax.ws.rs.core.Response getStoptimesForStopAndDate(@PathParam(value="stopId")
                                                                                                                  String stopIdString,
                                                                                                                  @PathParam(value="date")
                                                                                                                  String date,
                                                                                                                  @QueryParam(value="omitNonPickups")
                                                                                                                  boolean omitNonPickups)

Return upcoming vehicle arrival/departure times at the given stop.

Parameters:

date - in YYYYMMDD format

getTransfers

@GET
 @Path(value="/stops/{stopId}/transfers")
public javax.ws.rs.core.Response getTransfers(@PathParam(value="stopId")
                                                                                             String stopIdString)

Return the generated transfers a stop in the graph, by stop ID

getRoutes

@GET
 @Path(value="/routes")
public javax.ws.rs.core.Response getRoutes(@QueryParam(value="hasStop")
                                                                        List<String> stopIds)

Return a list of all routes in the graph.

getRoute

@GET
 @Path(value="/routes/{routeId}")
public javax.ws.rs.core.Response getRoute(@PathParam(value="routeId")
                                                                                 String routeIdString)

Return specific route in the graph, for the given ID.

getPatternsForRoute

@GET
 @Path(value="/routes/{routeId}/patterns")
public javax.ws.rs.core.Response getPatternsForRoute(@PathParam(value="routeId")
                                                                                                     String routeIdString)

Return all stop patterns used by trips on the given route.

getStopsForRoute

@GET
 @Path(value="/routes/{routeId}/stops")
public javax.ws.rs.core.Response getStopsForRoute(@PathParam(value="routeId")
                                                                                               String routeIdString)

Return all stops in any pattern on a given route.

getTripsForRoute

@GET
 @Path(value="/routes/{routeId}/trips")
public javax.ws.rs.core.Response getTripsForRoute(@PathParam(value="routeId")
                                                                                               String routeIdString)

Return all trips in any pattern on the given route.

getTrip

@GET
 @Path(value="/trips/{tripId}")
public javax.ws.rs.core.Response getTrip(@PathParam(value="tripId")
                                                                              String tripIdString)

getStopsForTrip

@GET
 @Path(value="/trips/{tripId}/stops")
public javax.ws.rs.core.Response getStopsForTrip(@PathParam(value="tripId")
                                                                                            String tripIdString)

getSemanticHashForTrip

@GET
 @Path(value="/trips/{tripId}/semanticHash")
public javax.ws.rs.core.Response getSemanticHashForTrip(@PathParam(value="tripId")
                                                                                                          String tripIdString)

getStoptimesForTrip

@GET
 @Path(value="/trips/{tripId}/stoptimes")
public javax.ws.rs.core.Response getStoptimesForTrip(@PathParam(value="tripId")
                                                                                                    String tripIdString)

getGeometryForTrip

@GET
 @Path(value="/trips/{tripId}/geometry")
public javax.ws.rs.core.Response getGeometryForTrip(@PathParam(value="tripId")
                                                                                                  String tripIdString)

Return geometry for the trip as a packed coordinate sequence

getPatterns

@GET
 @Path(value="/patterns")
public javax.ws.rs.core.Response getPatterns()

getPattern

@GET
 @Path(value="/patterns/{patternId}")
public javax.ws.rs.core.Response getPattern(@PathParam(value="patternId")
                                                                                       String patternIdString)

getTripsForPattern

@GET
 @Path(value="/patterns/{patternId}/trips")
public javax.ws.rs.core.Response getTripsForPattern(@PathParam(value="patternId")
                                                                                                     String patternIdString)

getStopsForPattern

@GET
 @Path(value="/patterns/{patternId}/stops")
public javax.ws.rs.core.Response getStopsForPattern(@PathParam(value="patternId")
                                                                                                     String patternIdString)

getSemanticHashForPattern

@GET
 @Path(value="/patterns/{patternId}/semanticHash")
public javax.ws.rs.core.Response getSemanticHashForPattern(@PathParam(value="patternId")
                                                                                                                   String patternIdString)

getGeometryForPattern

@GET
 @Path(value="/patterns/{patternId}/geometry")
public javax.ws.rs.core.Response getGeometryForPattern(@PathParam(value="patternId")
                                                                                                           String patternIdString)

Return geometry for the pattern as a packed coordinate sequence

getServices

@GET
 @Path(value="/services")
public javax.ws.rs.core.Response getServices()

List basic information about all service IDs. This is a placeholder endpoint and is not implemented yet.

getServices

@GET
 @Path(value="/services/{serviceId}")
public javax.ws.rs.core.Response getServices(@PathParam(value="serviceId")
                                                                                        String serviceId)

List details about a specific service ID including which dates it runs on. Replaces the old /calendar. This is a placeholder endpoint and is not implemented yet.

getAllStopClusters

@GET
 @Path(value="/clusters")
public javax.ws.rs.core.Response getAllStopClusters()

Return all clusters of stops. A cluster is not the same thing as a GTFS parent station. Clusters are an unsupported experimental feature that was added to assist in "profile routing". As such the stop clustering method probably only works right with one or two GTFS data sets in the world.

getStopCluster

@GET
 @Path(value="/clusters/{clusterId}")
public javax.ws.rs.core.Response getStopCluster(@PathParam(value="clusterId")
                                                                                           String clusterIdString)

Return a cluster of stops by its ID. A cluster is not the same thing as a GTFS parent station. Clusters are an unsupported experimental feature that was added to assist in "profile routing". As such the stop clustering method probably only works right with one or two GTFS data sets in the world.

getAllFlexAreas

@GET
 @Path(value="/flexAreas")
public javax.ws.rs.core.Response getAllFlexAreas()

Return all GTFS-Flex area IDs. Areas are defined in GTFS-Flex to be a lat/lon polygon in which certain kinds of flex service take place (deviated-route and call-and-ride).

getFlexAreaByFeedId

@GET
 @Path(value="/flexAreas/{id}")
public javax.ws.rs.core.Response getFlexAreaByFeedId(@PathParam(value="id")
                                                                                          String areaIdString)

Return a specific GTFS-Flex area given an ID in Agency:ID format.

getGraphQL

@POST
 @Path(value="/graphql")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getGraphQL(HashMap<String,Object> queryParameters)

getGraphQL

@POST
 @Path(value="/graphql")
 @Consumes(value="application/graphql")
public javax.ws.rs.core.Response getGraphQL(String query)