org.transitime.api.rootResources

Class CommandsApi

java.lang.Object

org.transitime.api.rootResources.CommandsApi

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

Constructor Summary

Constructors

Constructor and Description
CommandsApi()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	pushAvlData(StandardParameters stdParameters, java.io.InputStream requestBody) Processes a POST http request contain AVL data in the message body in JSON format.
javax.ws.rs.core.Response	pushAvlData(StandardParameters stdParameters, java.lang.String vehicleId, long time, double lat, double lon, float speed, float heading, java.lang.String assignmentId, java.lang.String assignmentTypeStr) Reads in a single AVL report specified by the query string parameters v=vehicleId &t=epochTimeInMsec&lat=latitude&lon=longitude&s=speed(optional) &h=heading(option) .

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandsApi

public CommandsApi()

Method Detail

pushAvlData

@Path(value="/command/pushAvl")
 @GET
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response pushAvlData(@BeanParam
                                                                                                                                               StandardParameters stdParameters,
                                                                                                                                               @QueryParam(value="v")
                                                                                                                                               java.lang.String vehicleId,
                                                                                                                                               @QueryParam(value="t")
                                                                                                                                               long time,
                                                                                                                                               @QueryParam(value="lat")
                                                                                                                                               double lat,
                                                                                                                                               @QueryParam(value="lon")
                                                                                                                                               double lon,
                                                                                                                                               @QueryParam(value="s") @DefaultValue(value="NaN")
                                                                                                                                               float speed,
                                                                                                                                               @QueryParam(value="h") @DefaultValue(value="NaN")
                                                                                                                                               float heading,
                                                                                                                                               @QueryParam(value="assignmentId")
                                                                                                                                               java.lang.String assignmentId,
                                                                                                                                               @QueryParam(value="assignmentType")
                                                                                                                                               java.lang.String assignmentTypeStr)
                                                                                                                                        throws javax.ws.rs.WebApplicationException

Reads in a single AVL report specified by the query string parameters v=vehicleId &t=epochTimeInMsec&lat=latitude&lon=longitude&s=speed(optional) &h=heading(option) . Can also optionally specify assignmentType="1234" and assignmentType="BLOCK_ID" or ROUTE_ID, TRIP_ID, or TRIP_SHORT_NAME.

Parameters:

stdParameters -

vehicleId -

time -

lat -

lon -

speed - (optional)

heading - (optional)

assignmentId - (optional)

assignmentTypeStr - (optional)

Returns:

ApiCommandAck response indicating whether successful

Throws:

javax.ws.rs.WebApplicationException

pushAvlData

@Path(value="/command/pushAvl")
 @POST
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response pushAvlData(@BeanParam
                                                                                                                                                StandardParameters stdParameters,
                                                                                                                                                java.io.InputStream requestBody)
                                                                                                                                         throws javax.ws.rs.WebApplicationException

Processes a POST http request contain AVL data in the message body in JSON format. The data format is:

{avl: [{v: "vehicleId1", t: epochTimeMsec, lat: latitude, lon: longitude, s:speed(optional), h:heading(optional)}, {v: "vehicleId2", t: epochTimeMsec, lat: latitude, lon: longitude, s: speed(optional), h: heading(optional)}, {etc...} ] }

Note: can also specify assignment info using "assignmentId: 4321, assignmentType: TRIP_ID" where assignmentType can be BLOCK_ID, ROUTE_ID, TRIP_ID, or TRIP_SHORT_NAME.

Parameters:

stdParameters -

requestBody -

Returns:

ApiCommandAck response indicating whether successful

Throws:

javax.ws.rs.WebApplicationException