org.transitime.api.rootResources

Class SiriApi

java.lang.Object

org.transitime.api.rootResources.SiriApi

@Path(value="/key/{key}/agency/{agency}")
public class SiriApi
extends java.lang.Object

The Siri API

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
SiriApi()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getVehicles(StandardParameters stdParameters, java.util.List<java.lang.String> vehicleIds, java.util.List<java.lang.String> routesIdOrShortNames) Returns vehicleMonitoring vehicle information in SIRI format.
javax.ws.rs.core.Response	getVehicles(StandardParameters stdParameters, java.lang.String routeIdOrShortName, java.lang.String stopId, int numberPredictions) Returns stopMonitoring vehicle information in SIRI format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiriApi

public SiriApi()

Method Detail

getVehicles

@Path(value="/command/siri/vehicleMonitoring")
 @GET
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getVehicles(@BeanParam
                                                                                                                                                              StandardParameters stdParameters,
                                                                                                                                                              @QueryParam(value="v")
                                                                                                                                                              java.util.List<java.lang.String> vehicleIds,
                                                                                                                                                              @QueryParam(value="r")
                                                                                                                                                              java.util.List<java.lang.String> routesIdOrShortNames)
                                                                                                                                                       throws javax.ws.rs.WebApplicationException

Returns vehicleMonitoring vehicle information in SIRI format. Can specify vehicleIds, routeIds, or routeShortNames to get subset of data. If not specified then vehicle information for entire agency is returned.

Parameters:

stdParameters -

vehicleIds - List of vehicle IDs

routesIdOrShortNames - List of routes

Returns:

The response

Throws:

javax.ws.rs.WebApplicationException

getVehicles

@Path(value="/command/siri/stopMonitoring")
 @GET
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getVehicles(@BeanParam
                                                                                                                                                           StandardParameters stdParameters,
                                                                                                                                                           @QueryParam(value="r")
                                                                                                                                                           java.lang.String routeIdOrShortName,
                                                                                                                                                           @QueryParam(value="s")
                                                                                                                                                           java.lang.String stopId,
                                                                                                                                                           @QueryParam(value="numPreds") @DefaultValue(value="3")
                                                                                                                                                           int numberPredictions)
                                                                                                                                                    throws javax.ws.rs.WebApplicationException

Returns stopMonitoring vehicle information in SIRI format. Can specify routeId or routeShortName. Need to also specify stopId. Can optionally specify how many max number of predictions per stop to return.

Parameters:

stdParameters -

routeIdOrShortName -

stopId -

numberPredictions -

Returns:

Throws:

javax.ws.rs.WebApplicationException