Data Types

JSON

type description
AbsoluteDirection An absolute cardinal or intermediate direction.
AgencyAndId
AgencyAndIdType
Alert
AlertPatch This adds a note to all boardings of a given route or stop (optionally, in a given direction)
AlertPatchCreationResponse
AlertPatchResponse
AlertPatchSet
BikeRentalStationList
Currency
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.
EncodedPolylineBean A list of coordinates encoded as a string. See Encoded polyline algorithm format
Fare

Fare is a set of fares for different classes of users.

FareType
GeocoderResult
GeocoderResults
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
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.
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.
Properties The purpose of Properties is to easily read a ResourceBundel (set of localized .properties files), and get the named contents. Goes really well with an enumerated type (@see org.opentripplanner.api.ws.Message)
RelativeDirection Represents a turn direction, relative to the current heading. CIRCLE_CLOCKWISE and CIRCLE_CLOCKWISE are used to represent traffic circles.
Response Represents a trip planner response, will be serialized into XML or JSON by Jersey
RouterInfo
RouterList
ServerInfo
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.
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):
distance = 100 (say)
walkDirection = RIGHT
streetName = Broadway
everything else null/false

Now, turn from Broadway onto Central Park S via Columbus Circle
distance = 200 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Central Park S
exit = 1 (first exit)
immediately everything else false

Instead, go through the circle to continue on Broadway
distance = 100 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Broadway
exit = 3
stayOn = true
everything else false

WrappedCurrency A Bean wrapper class for java.util.Currency

XML

Default Namespace
type description
agencyAndId
agencyAndIdType
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.
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
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):
distance = 100 (say)
walkDirection = RIGHT
streetName = Broadway
everything else null/false

Now, turn from Broadway onto Central Park S via Columbus Circle
distance = 200 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Central Park S
exit = 1 (first exit)
immediately everything else false

Instead, go through the circle to continue on Broadway
distance = 100 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Broadway
exit = 3
stayOn = true
everything else false

alertPatchCreationResponse
alertPatchResponse
alertPatchSet
localizedAlert
plannerError This API response element represents an error in trip planning.
bikeRentalStationList
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.
inspectorLayersList
inspectorLayer
response Represents a trip planner response, will be serialized into XML or JSON by Jersey
serverInfo
mavenVersion
alert
alertPatch This adds a note to all boardings of a given route or stop (optionally, in a given direction)
bikeRentalStation
fare

Fare is a set of fares for different classes of users.

fareType
money Fare support is very, very preliminary.
TraverseMode
wrappedCurrency A Bean wrapper class for java.util.Currency
i18NString This interface is used when providing translations on server side.
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