org.transitime.api.rootResources

Class TransitimeNonAgencyApi

java.lang.Object

org.transitime.api.rootResources.TransitimeNonAgencyApi

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

Contains the API commands for the Transitime API for system wide commands, such as determining all agencies. The intent of this feed is to provide what is needed for creating a user interface application, such as a smartphone application.

The data output can be in either JSON or XML. The output format is specified by the accept header or by using the query string parameter "format=json" or "format=xml".

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
TransitimeNonAgencyApi()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAgencies(StandardParameters stdParameters) For "agencies" command.
javax.ws.rs.core.Response	getPredictions(StandardParameters stdParameters, java.lang.Double lat, java.lang.Double lon, double maxDistance, int numberPredictions) For "predictionsByLoc" command when want to return data for any agency instead of a single specific one.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitimeNonAgencyApi

public TransitimeNonAgencyApi()

Method Detail

getAgencies

@Path(value="/command/agencies")
 @GET
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getAgencies(@BeanParam
                                                                                                                                                StandardParameters stdParameters)
                                                                                                                                         throws javax.ws.rs.WebApplicationException

For "agencies" command. Returns information for all configured agencies.

Parameters:

stdParameters -

Returns:

Throws:

javax.ws.rs.WebApplicationException

getPredictions

@Path(value="/command/predictionsByLoc")
 @GET
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getPredictions(@BeanParam
                                                                                                                                                           StandardParameters stdParameters,
                                                                                                                                                           @QueryParam(value="lat")
                                                                                                                                                           java.lang.Double lat,
                                                                                                                                                           @QueryParam(value="lon")
                                                                                                                                                           java.lang.Double lon,
                                                                                                                                                           @QueryParam(value="maxDistance") @DefaultValue(value="1500.0")
                                                                                                                                                           double maxDistance,
                                                                                                                                                           @QueryParam(value="numPreds") @DefaultValue(value="3")
                                                                                                                                                           int numberPredictions)
                                                                                                                                                    throws javax.ws.rs.WebApplicationException

For "predictionsByLoc" command when want to return data for any agency instead of a single specific one.

Parameters:

stdParameters - StdParametersBean that gets the standard parameters from the URI, query string, and headers.

lat - latitude in decimal degrees

lon - longitude in decimal degrees

maxDistance - How far away a stop can be from the lat/lon. Default is 1,500 m.

numberPredictions - Maximum number of predictions to return. Default value is 3.

Returns:

Throws:

javax.ws.rs.WebApplicationException