Skip to content

Instantly share code, notes, and snippets.

@buma

buma/opentripplanner.adoc

Created November 16, 2015 17:09
Show Gist options
  • Save buma/23b14d4604bb35f8dfaa to your computer and use it in GitHub Desktop.
Save buma/23b14d4604bb35f8dfaa to your computer and use it in GitHub Desktop.
Download ZIP
Generated ascidoc for OTP
Raw
opentripplanner.adoc

REST resources of project

`GET `

Request

No body

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.resource.ServerInfo)
application/json: {"serverVersion":{"version":"string","major":0,"minor":0,"incremental":0,"qualifier":"string","commit":"string","describe":"string","commit_time":"string","build_time":"string","uID":0,"shortVersionString":"string","longVersionString":"string"},"cpuName":"string","nCores":0}

GET analyst/legend.{format}

Request

No body
Path Param: format, java.lang.String
Query Param: height, int
Query Param: styles, org.opentripplanner.api.parameter.StyleList
Query Param: width, int

Response

Content-Type: image/*

200 OK

Header: Cache-Control
Response Body: (org.opentripplanner.analyst.request.Renderer$1)
application/json: {}

GET application.wadl

Request

No body

Response

Content-Type: application/vnd.sun.wadl+xml, application/xml

200 OK

Header: Last-modified
Response Body: (java.io.ByteArrayInputStream)

404 Not Found

GET geocode

Request

No body
Query Param: address, java.lang.String
Query Param: bbox, org.opentripplanner.api.parameter.BoundingBox

Response

Content-Type: application/json; charset=UTF-8

200 OK

Response Body: (org.opentripplanner.geocoder.GeocoderResults)
application/json: {"error":"string","results":[{"lat":0.0,"lng":0.0,"description":"string"}],"count":0}

GET municoder

Request

No body
Query Param: callback, java.lang.String
Query Param: location, java.lang.String

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.String)

POST patch/patch

Request

Content-Type: application/json, application/xml, text/xml
Request Body: (org.opentripplanner.api.model.alertpatch.AlertPatchSet)
application/json: {"alertPatches":[{"alert":{"alertHeaderText":{"translations":{},"translation":"string","someTranslation":"string"},"alertDescriptionText":{},"alertUrl":{},"effectiveStartDate":"date"},"id":"string","agency":"string","route":{"agencyId":"string","id":"string"},"trip":{},"stop":{},"direction":"string","directionId":0}]}

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.model.alertpatch.AlertPatchCreationResponse)
application/json: {"status":"string"}

GET patch/routePatches

Request

No body
Query Param: agency, java.lang.String
Query Param: id, java.lang.String

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.model.alertpatch.AlertPatchResponse)
application/json: {"alertPatches":[{"alert":{"alertHeaderText":{"translations":{},"translation":"string","someTranslation":"string"},"alertDescriptionText":{},"alertUrl":{},"effectiveStartDate":"date"},"id":"string","agency":"string","route":{"agencyId":"string","id":"string"},"trip":{},"stop":{},"direction":"string","directionId":0}]}

GET patch/stopPatches

Request

No body
Query Param: agency, java.lang.String
Query Param: id, java.lang.String

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.model.alertpatch.AlertPatchResponse)
application/json: {"alertPatches":[{"alert":{"alertHeaderText":{"translations":{},"translation":"string","someTranslation":"string"},"alertDescriptionText":{},"alertUrl":{},"effectiveStartDate":"date"},"id":"string","agency":"string","route":{"agencyId":"string","id":"string"},"trip":{},"stop":{},"direction":"string","directionId":0}]}

GET pointsets

Request

No body

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.model.PointSetShort)
application/json: [{"id":"string","n":0}]

GET pointsets/{pointSetId}

Request

No body
Path Param: pointSetId, java.lang.String

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.model.PointSetShort)
application/json: {"id":"string","n":0}

404 Not Found

Response Body: (java.lang.String)

GET routers

Request

No body

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.model.RouterList)
application/json: {"routerInfo":[{"routerId":"string","polygon":{"geometryType":"string","sRID":0,"factory":{"precisionModel":{"floating":false,"maximumSignificantDigits":0,"scale":0.0,"type":{},"offsetX":0.0,"offsetY":0.0},"sRID":0,"coordinateSequenceFactory":{}},"userData":{},"numGeometries":0,"geometryN":{},"precisionModel":{},"coordinate":{"x":0.0,"y":0.0,"z":0.0,"ordinate":0.0},"coordinates":{},"numPoints":0,"simple":false,"valid":false,"empty":false,"withinDistance":false,"rectangle":false,"area":0.0,"length":0.0,"centroid":{"coordinates":{},"numPoints":0,"empty":false,"simple":false,"dimension":0,"boundaryDimension":0,"x":0.0,"y":0.0,"coordinate":{},"geometryType":"string","boundary":{},"coordinateSequence":{"dimension":0,"coordinate":{},"coordinateCopy":{},"x":0.0,"y":0.0,"ordinate":0.0}},"interiorPoint":{},"dimension":0,"boundary":{},"boundaryDimension":0,"envelope":{},"envelopeInternal":{"null":false,"width":0.0,"height":0.0,"minX":0.0,"maxX":0.0,"minY":0.0,"maxY":0.0,"area":0.0}},"buildTime":"date"}]}

PUT routers

Request

No body
Query Param: force, boolean
Query Param: path, java.lang.String
Query Param: preEvict, boolean

Response

Content-Type: application/json

200 OK

DELETE routers

Request

No body

Response

Content-Type: text/plain

200 OK

Response Body: (java.lang.String)

POST routers/save

Request

Content-Type: application/octet-stream
Request Body: (java.io.InputStream)
Query Param: routerId, java.lang.String

Response

Content-Type: text/plain

201 Created

Response Body: (java.lang.String)

400 Bad Request

Response Body: (java.lang.String)

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}

Request

No body
Path Param: routerId, java.lang.String

Response

Content-Type: text/plain

200 OK

Response Body: (org.opentripplanner.api.model.RouterInfo)
application/json: {"routerId":"string","polygon":{"geometryType":"string","sRID":0,"factory":{"precisionModel":{"floating":false,"maximumSignificantDigits":0,"scale":0.0,"type":{},"offsetX":0.0,"offsetY":0.0},"sRID":0,"coordinateSequenceFactory":{}},"userData":{},"numGeometries":0,"geometryN":{},"precisionModel":{},"coordinate":{"x":0.0,"y":0.0,"z":0.0,"ordinate":0.0},"coordinates":{},"numPoints":0,"simple":false,"valid":false,"empty":false,"withinDistance":false,"rectangle":false,"area":0.0,"length":0.0,"centroid":{"coordinates":{},"numPoints":0,"empty":false,"simple":false,"dimension":0,"boundaryDimension":0,"x":0.0,"y":0.0,"coordinate":{},"geometryType":"string","boundary":{},"coordinateSequence":{"dimension":0,"coordinate":{},"coordinateCopy":{},"x":0.0,"y":0.0,"ordinate":0.0}},"interiorPoint":{},"dimension":0,"boundary":{},"boundaryDimension":0,"envelope":{},"envelopeInternal":{"null":false,"width":0.0,"height":0.0,"minX":0.0,"maxX":0.0,"minY":0.0,"maxY":0.0,"area":0.0}},"buildTime":"date"}

404 Not Found

Response Body: (java.lang.String)

PUT routers/{routerId}

Request

No body
Path Param: routerId, java.lang.String
Query Param: preEvict, boolean

Response

Content-Type: text/plain

201 Created

Response Body: (java.lang.String)

404 Not Found

Response Body: (java.lang.String)

POST routers/{routerId}

Request

Content-Type: application/zip
Request Body: (java.io.InputStream)
Path Param: routerId, java.lang.String
Query Param: preEvict, boolean

Response

Content-Type: text/plain

201 Created

Response Body: (java.lang.String)

400 Bad Request

Response Body: (java.lang.String)

POST routers/{routerId}

Request

Content-Type: application/octet-stream
Request Body: (java.io.InputStream)
Path Param: routerId, java.lang.String
Query Param: loadLevel, org.opentripplanner.routing.graph.Graph$LoadLevel
Query Param: preEvict, boolean

Response

Content-Type: text/plain

201 Created

Response Body: (java.lang.String)

400 Bad Request

Response Body: (java.lang.String)

DELETE routers/{routerId}

Request

No body
Path Param: routerId, java.lang.String

Response

Content-Type: text/plain

200 OK

Response Body: (java.lang.String)

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/analyst/raster

Request

No body
Query Param: crs, org.opentripplanner.api.parameter.CRSParameter
Query Param: format, org.opentripplanner.api.parameter.MIMEImageFormat
Query Param: height, java.lang.Integer
Query Param: resolution, java.lang.Double
Query Param: time, org.opentripplanner.api.parameter.IsoTimeParameter
Query Param: width, java.lang.Integer
Query Param: x, java.lang.Float
Query Param: y, java.lang.Float

Response

Content-Type: image/*

204 No Content

GET routers/{routerId}/analyst/tile/{z}/{x}/{y}.png

Request

No body
Path Param: x, int
Path Param: y, int
Path Param: z, int
Query Param: format, org.opentripplanner.api.parameter.MIMEImageFormat
Query Param: layers, org.opentripplanner.api.parameter.LayerList
Query Param: styles, org.opentripplanner.api.parameter.StyleList

Response

Content-Type: image/*

204 No Content

GET routers/{routerId}/bike_rental

Request

No body
Path Param: routerId, java.lang.String
Query Param: lowerLeft, java.lang.String
Query Param: upperRight, java.lang.String

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.resource.BikeRentalStationList)
application/json: {"stations":[{"id":"string","name":"string","x":0.0,"y":0.0,"bikesAvailable":0,"spacesAvailable":0,"allowDropoff":false,"networks":["string"],"realTimeData":false}]}

GET routers/{routerId}/geocode

Request

No body
Query Param: autocomplete, boolean
Query Param: clusters, boolean
Query Param: corners, boolean
Query Param: query, java.lang.String
Query Param: stops, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.common.LuceneIndex$LuceneResult)
application/json: [{"lat":0.0,"lng":0.0,"description":"string","id":"string"}]

GET routers/{routerId}/index/agencies

Request

No body
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.Object)
application/json: [{}]

GET routers/{routerId}/index/agencies/{agencyId}

Request

No body
Path Param: agencyId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Agency)
application/json: {"id":"string","name":"string","url":"string","timezone":"string","lang":"string","phone":"string","fareUrl":"string"}

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/agencies/{agencyId}/routes

Request

No body
Path Param: agencyId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.RouteShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"shortName":"string","longName":"string","mode":"string","color":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/clusters

Request

No body
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopClusterDetail)
application/json: [{"id":"string","name":"string","lat":0.0,"lon":0.0,"stops":[{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}]}]

GET routers/{routerId}/index/clusters/{clusterId}

Request

No body
Path Param: clusterId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopClusterDetail)
application/json: {"id":"string","name":"string","lat":0.0,"lon":0.0,"stops":[{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}]}

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/patterns

Request

No body
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.PatternShort)
application/json: [{"id":"string","desc":"string"}]

GET routers/{routerId}/index/patterns/{patternId}

Request

No body
Path Param: patternId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.PatternDetail)
application/json: {"routeId":{"agencyId":"string","id":"string"},"stops":[{"id":{},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}],"trips":[{"id":{},"tripHeadsign":"string","serviceId":{},"shapeId":"string","direction":0}]}

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/patterns/{patternId}/geometry

Request

No body
Path Param: patternId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Stop)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","desc":"string","lat":0.0,"lon":0.0,"zoneId":"string","url":"string","locationType":0,"parentStation":"string","wheelchairBoarding":0,"direction":"string","timezone":"string","vehicleTypeSet":false,"vehicleType":0,"platformCode":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/patterns/{patternId}/semanticHash

Request

No body
Path Param: patternId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Stop)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","desc":"string","lat":0.0,"lon":0.0,"zoneId":"string","url":"string","locationType":0,"parentStation":"string","wheelchairBoarding":0,"direction":"string","timezone":"string","vehicleTypeSet":false,"vehicleType":0,"platformCode":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/patterns/{patternId}/stops

Request

No body
Path Param: patternId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/patterns/{patternId}/trips

Request

No body
Path Param: patternId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.TripShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"tripHeadsign":"string","serviceId":{},"shapeId":"string","direction":0}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/routes

Request

No body
Query Param: detail, boolean
Query Param: hasStop, java.util.List<java.lang.String>
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.RouteShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"shortName":"string","longName":"string","mode":"string","color":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/routes/{routeId}

Request

No body
Path Param: routeId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Stop)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","desc":"string","lat":0.0,"lon":0.0,"zoneId":"string","url":"string","locationType":0,"parentStation":"string","wheelchairBoarding":0,"direction":"string","timezone":"string","vehicleTypeSet":false,"vehicleType":0,"platformCode":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/routes/{routeId}/patterns

Request

No body
Path Param: routeId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.PatternShort)
application/json: [{"id":"string","desc":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/routes/{routeId}/stops

Request

No body
Path Param: routeId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/routes/{routeId}/trips

Request

No body
Path Param: routeId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.TripShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"tripHeadsign":"string","serviceId":{},"shapeId":"string","direction":0}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/services

Request

No body
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.String)

GET routers/{routerId}/index/services/{serviceId}

Request

No body
Path Param: serviceId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops

Request

No body
Query Param: detail, boolean
Query Param: lat, java.lang.Double
Query Param: lon, java.lang.Double
Query Param: maxLat, java.lang.Double
Query Param: maxLon, java.lang.Double
Query Param: minLat, java.lang.Double
Query Param: minLon, java.lang.Double
Query Param: radius, java.lang.Double
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}]

400 Bad Request

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops/{stopId}

Request

No body
Path Param: stopId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Stop)
application/json: {"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","desc":"string","lat":0.0,"lon":0.0,"zoneId":"string","url":"string","locationType":0,"parentStation":"string","wheelchairBoarding":0,"direction":"string","timezone":"string","vehicleTypeSet":false,"vehicleType":0,"platformCode":"string"}

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops/{stopId}/patterns

Request

No body
Path Param: stopId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.PatternShort)
application/json: [{"id":"string","desc":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops/{stopId}/routes

Request

No body
Path Param: stopId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.RouteShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"shortName":"string","longName":"string","mode":"string","color":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops/{stopId}/stoptimes

Request

No body
Path Param: stopId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopTimesInPattern)
application/json: [{"pattern":{"id":"string","desc":"string"},"times":[{"stopId":{"agencyId":"string","id":"string"},"scheduledArrival":0,"scheduledDeparture":0,"realtimeArrival":0,"realtimeDeparture":0,"arrivalDelay":0,"departureDelay":0,"timepoint":false,"realtime":false,"serviceDay":0,"tripId":{}}]}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops/{stopId}/stoptimes/{date}

Request

No body
Path Param: date, java.lang.String
Path Param: stopId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopTimesInPattern)
application/json: [{"pattern":{"id":"string","desc":"string"},"times":[{"stopId":{"agencyId":"string","id":"string"},"scheduledArrival":0,"scheduledDeparture":0,"realtimeArrival":0,"realtimeDeparture":0,"arrivalDelay":0,"departureDelay":0,"timepoint":false,"realtime":false,"serviceDay":0,"tripId":{}}]}]

400 Bad Request

Response Body: (java.lang.String)

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/stops/{stopId}/transfers

Request

No body
Path Param: stopId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Stop)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","desc":"string","lat":0.0,"lon":0.0,"zoneId":"string","url":"string","locationType":0,"parentStation":"string","wheelchairBoarding":0,"direction":"string","timezone":"string","vehicleTypeSet":false,"vehicleType":0,"platformCode":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/trips/{tripId}

Request

No body
Path Param: tripId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.onebusaway.gtfs.model.Stop)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","desc":"string","lat":0.0,"lon":0.0,"zoneId":"string","url":"string","locationType":0,"parentStation":"string","wheelchairBoarding":0,"direction":"string","timezone":"string","vehicleTypeSet":false,"vehicleType":0,"platformCode":"string"}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/trips/{tripId}/geometry

Request

No body
Path Param: tripId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.util.model.EncodedPolylineBean)
application/json: {"points":"string","levels":"string","length":0}

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/trips/{tripId}/semanticHash

Request

No body
Path Param: tripId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (com.fasterxml.jackson.databind.node.MissingNode)
application/json: {"nodeType":"string"}

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/trips/{tripId}/stops

Request

No body
Path Param: tripId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.StopShort)
application/json: [{"id":{"agencyId":"string","id":"string"},"code":"string","name":"string","lat":0.0,"lon":0.0,"cluster":"string","dist":0}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/index/trips/{tripId}/stoptimes

Request

No body
Path Param: tripId, java.lang.String
Query Param: detail, boolean
Query Param: refs, boolean

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.index.model.TripTimeShort)
application/json: [{"stopId":{"agencyId":"string","id":"string"},"scheduledArrival":0,"scheduledDeparture":0,"realtimeArrival":0,"realtimeDeparture":0,"arrivalDelay":0,"departureDelay":0,"timepoint":false,"realtime":false,"serviceDay":0,"tripId":{}}]

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/inspector/layers

Request

No body
Path Param: ext, java.lang.String
Path Param: layer, java.lang.String
Path Param: routerId, java.lang.String
Path Param: x, int
Path Param: y, int
Path Param: z, int

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.resource.InspectorLayersList)
application/json: {"layers":[{}]}

GET routers/{routerId}/inspector/tile/{layer}/{z}/{x}/{y}.{ext}

Request

No body
Path Param: ext, java.lang.String
Path Param: layer, java.lang.String
Path Param: routerId, java.lang.String
Path Param: x, int
Path Param: y, int
Path Param: z, int

Response

Content-Type: image/*

200 OK

Header: Cache-Control
Response Body: (byte[])
application/json: {}

GET routers/{routerId}/isochrone

Request

No body
Query Param: coordinateOrigin, java.lang.String
Query Param: cutoffSec, java.util.List<java.lang.Integer>
Query Param: debug, java.lang.Boolean
Query Param: maxTimeSec, java.lang.Integer
Query Param: precisionMeters, java.lang.Integer

Response

Content-Type: application/json

200 OK

Header: Cache-Control
Response Body: (java.lang.String)

GET routers/{routerId}/isochrone

Request

No body
Query Param: coordinateOrigin, java.lang.String
Query Param: cutoffSec, java.util.List<java.lang.Integer>
Query Param: debug, java.lang.Boolean
Query Param: maxTimeSec, java.lang.Integer
Query Param: precisionMeters, java.lang.Integer
Query Param: shpName, java.lang.String
Query Param: stream, boolean

Response

Content-Type: application/x-zip-compressed

200 OK

Response Body: (java.io.File)

GET routers/{routerId}/isochroneOld

Request

No body
Query Param: output, java.lang.String
Query Param: walkTime, double

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.String)

400 Bad Request

Response Body: (java.lang.String)

GET routers/{routerId}/metadata

Request

No body
Path Param: routerId, java.lang.String

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.resource.GraphMetadata)
application/json: {"lowerLeftLatitude":0.0,"upperRightLatitude":0.0,"upperRightLongitude":0.0,"lowerLeftLongitude":0.0,"minLatitude":0.0,"minLongitude":0.0,"maxLatitude":0.0,"maxLongitude":0.0,"transitModes":["string"],"centerLongitude":0.0,"centerLatitude":0.0}

GET routers/{routerId}/plan

Request

No body

Response

Content-Type: application/json, application/xml;qs=0.5, text/xml;qs=0.5

200 OK

Response Body: (org.opentripplanner.api.resource.Response)
application/json: {"requestParameters":{},"debugOutput":{"precalculationTime":0,"pathCalculationTime":0,"pathTimes":[0],"renderingTime":0,"totalTime":0,"timedOut":false},"plan":{"date":"date","from":{"name":"string","stopId":{"agencyId":"string","id":"string"},"stopCode":"string","platformCode":"string","lon":0.0,"lat":0.0,"arrival":{"time":"date","timeInMillis":0,"set":false,"displayName":"string","displayNames":{},"calendarType":"string","timeZone":{"offset":0,"rawOffset":0,"iD":"string","displayName":"string","dSTSavings":0},"lenient":false,"firstDayOfWeek":0,"minimalDaysInFirstWeek":0,"weekDateSupported":false,"weekYear":0,"weeksInWeekYear":0,"minimum":0,"maximum":0,"greatestMinimum":0,"leastMaximum":0,"actualMinimum":0,"actualMaximum":0},"departure":{},"orig":"string","zoneId":"string","stopIndex":0,"stopSequence":0,"geometry":"string"},"to":{},"itinerary":[{"duration":0,"startTime":{},"endTime":{},"walkTime":0,"transitTime":0,"waitingTime":0,"walkDistance":0.0,"walkLimitExceeded":false,"elevationLost":0.0,"elevationGained":0.0,"transfers":0,"fare":{"fare":{"currency":{"defaultFractionDigits":0,"currencyCode":"string","symbol":"string","currency":{"currencyCode":"string","symbol":"string","defaultFractionDigits":0,"numericCode":0,"displayName":"string"}},"cents":0}},"legs":[{"startTime":{},"endTime":{},"departureDelay":0,"arrivalDelay":0,"realTime":false,"isNonExactFrequency":false,"headway":0,"distance":0.0,"pathway":false,"mode":"string","route":"string","agencyName":"string","agencyUrl":"string","agencyTimeZoneOffset":0,"routeColor":"string","routeType":0,"routeId":"string","routeTextColor":"string","interlineWithPreviousLeg":false,"tripShortName":"string","tripBlockId":"string","headsign":"string","agencyId":"string","tripId":"string","serviceDate":"string","from":{},"to":{},"stop":[{}],"legGeometry":{"points":"string","levels":"string","length":0},"walkSteps":[{"distance":0.0,"relativeDirection":"string","streetName":"string","absoluteDirection":"string","exit":"string","stayOn":false,"area":false,"bogusName":false,"lon":0.0,"lat":0.0,"alerts":[{"alertHeaderText":{"translations":{},"translation":"string","someTranslation":"string"},"alertDescriptionText":{},"alertUrl":{},"effectiveStartDate":"date"}],"angle":0.0,"newMode":"string","edges":[{"fromVertex":{"outgoing":[{}],"incoming":{},"x":0.0,"y":0.0,"lon":0.0,"lat":0.0,"name":"string","label":"string"},"toVertex":{},"partial":false,"equivalentTo":false,"reverseOf":false,"direction":"string","trip":{"id":{},"route":{"id":{},"agency":{"id":"string","name":"string","url":"string","timezone":"string","lang":"string","phone":"string","fareUrl":"string"},"shortName":"string","longName":"string","desc":"string","type":0,"url":"string","color":"string","textColor":"string","routeBikesAllowed":0,"bikesAllowed":0},"serviceId":{},"tripShortName":"string","tripHeadsign":"string","routeShortName":"string","directionId":"string","blockId":"string","shapeId":{},"wheelchairAccessible":0,"tripBikesAllowed":0,"bikesAllowed":0},"roundabout":false,"name":"string","geometry":{"coordinates":{},"coordinateSequence":{"dimension":0,"coordinate":{"x":0.0,"y":0.0,"z":0.0,"ordinate":0.0},"coordinateCopy":{},"x":0.0,"y":0.0,"ordinate":0.0},"coordinateN":{},"coordinate":false,"dimension":0,"boundaryDimension":0,"empty":false,"numPoints":0,"pointN":{"coordinates":{},"numPoints":0,"empty":false,"simple":false,"dimension":0,"boundaryDimension":0,"x":0.0,"y":0.0,"coordinate":{},"geometryType":"string","boundary":{"geometryType":"string","sRID":0,"factory":{"precisionModel":{"floating":false,"maximumSignificantDigits":0,"scale":0.0,"type":{},"offsetX":0.0,"offsetY":0.0},"sRID":0,"coordinateSequenceFactory":{}},"userData":{},"numGeometries":0,"geometryN":{},"precisionModel":{},"coordinate":{},"coordinates":{},"numPoints":0,"simple":false,"valid":false,"empty":false,"withinDistance":false,"rectangle":false,"area":0.0,"length":0.0,"centroid":{},"interiorPoint":{},"dimension":0,"boundary":{},"boundaryDimension":0,"envelope":{},"envelopeInternal":{"null":false,"width":0.0,"height":0.0,"minX":0.0,"maxX":0.0,"minY":0.0,"maxY":0.0,"area":0.0}},"coordinateSequence":{}},"startPoint":{},"endPoint":{},"closed":false,"ring":false,"geometryType":"string","length":0.0,"boundary":{}},"azimuth":0.0,"distance":0.0,"id":0}],"bikeRentalOnStation":{"id":"string","name":"string","lat":0.0,"lon":0.0},"bikeRentalOffStation":{},"elevation":[{}]}],"notes":[{"text":"string"}],"alerts":{},"routeShortName":"string","routeLongName":"string","boardRule":"string","alightRule":"string","rentedBike":false,"duration":0.0}],"tooSloped":false}]},"error":{"id":0,"msg":"string","message":"string","missing":["string"],"noPath":false}}

GET routers/{routerId}/profile

Request

No body
Query Param: accessModes, org.opentripplanner.api.parameter.QualifiedModeSet
Query Param: analyst, boolean
Query Param: bikeSafe, int
Query Param: bikeSlope, int
Query Param: bikeSpeed, float
Query Param: bikeTime, int
Query Param: carSpeed, float
Query Param: date, org.opentripplanner.api.param.YearMonthDay
Query Param: directModes, org.opentripplanner.api.parameter.QualifiedModeSet
Query Param: egressModes, org.opentripplanner.api.parameter.QualifiedModeSet
Query Param: endTime, org.opentripplanner.api.param.HourMinuteSecond
Query Param: from, org.opentripplanner.api.param.LatLon
Query Param: limit, int
Query Param: maxBikeTime, int
Query Param: maxCarTime, int
Query Param: maxWalkTime, int
Query Param: minBikeTime, int
Query Param: minCarTime, int
Query Param: orderBy, org.opentripplanner.profile.Option$SortOrder
Query Param: startTime, org.opentripplanner.api.param.HourMinuteSecond
Query Param: streetTime, int
Query Param: suboptimal, int
Query Param: to, org.opentripplanner.api.param.LatLon
Query Param: transitModes, org.opentripplanner.routing.core.TraverseModeSet
Query Param: walkSpeed, float

Response

Content-Type: application/json

200 OK

Response Body: (java.util.Map<java.lang.String, java.lang.Integer>)

500 Internal Server Error

Response Body: (java.lang.String)

GET routers/{routerId}/simpleIsochrone

Request

No body
Query Param: contourSpacingMinutes, int
Query Param: crs, java.lang.String
Query Param: nContours, int
Query Param: radiusMeters, double
Query Param: requestSpacingMinutes, int
Query Param: requestTimespanHours, int
Query Param: resultsProjected, boolean
Query Param: shpName, java.lang.String
Query Param: stopsOnly, boolean
Query Param: stream, boolean

Response

Content-Type: application/x-zip-compressed

200 OK

Response Body: (java.io.File)

GET routers/{routerId}/simpleIsochrone

Request

No body
Query Param: contourSpacingMinutes, int
Query Param: crs, java.lang.String
Query Param: nContours, int
Query Param: radiusMeters, double
Query Param: requestSpacingMinutes, int
Query Param: requestTimespanHours, int
Query Param: resultsProjected, boolean
Query Param: shpName, java.lang.String
Query Param: stopsOnly, boolean

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.String)

GET routers/{routerId}/timegrid

Request

No body
Query Param: base64, boolean
Query Param: coordinateOrigin, java.lang.String
Query Param: maxTimeSec, java.lang.Integer
Query Param: precisionMeters, java.lang.Integer
Query Param: zDataType, org.opentripplanner.api.resource.TimeGridWs$DataChannel

Response

Content-Type: image/png

200 OK

Header: OTPA-Grid-Corner
Header: Cache-Control
Header: OTPA-OffRoad-Dist
Header: OTPA-Grid-Cell-Size
Response Body: (org.opentripplanner.common.geometry.ZSampleGrid$ZSamplePoint<org.opentripplanner.analyst.request.SampleGridRenderer$WTWD>)
application/json: {"x":0,"y":0,"z":{"w":0.0,"wTime":0.0,"wBoardings":0.0,"wWalkDist":0.0,"d":0.0}}

GET routers/{routerId}/updaters

Request

No body
Query Param: detail, boolean

Response

Content-Type: application/json

200 OK

Response Body: (java.util.Map<java.lang.Integer, java.lang.String>)

404 Not Found

Response Body: (java.lang.String)

GET routers/{routerId}/updaters/{updaterId}

Request

No body
Path Param: updaterId, int
Query Param: detail, boolean

Response

Content-Type: application/json

200 OK

Response Body: (java.lang.Class)

404 Not Found

Response Body: (java.lang.String)

POST scripting/run

Request

Content-Type: multipart/form-data
Request Body: (org.glassfish.jersey.media.multipart.FormDataContentDisposition)
application/json: {"name":"string"}

Response

Content-Type: text/plain

200 OK

Response Body: (java.lang.Object)

403 Forbidden

Response Body: (java.lang.String)

500 Internal Server Error

Response Body: (java.lang.String)

GET surfaces

Request

No body

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.model.TimeSurfaceShort)
application/json: [{"id":0,"params":{}}]

POST surfaces

Request

No body
Query Param: cutoffMinutes, int
Query Param: routerId, java.lang.String

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.model.TimeSurfaceShort)
application/json: {"id":0,"params":{}}

204 No Content

Response Body: (java.lang.String)

400 Bad Request

Response Body: (java.lang.String)

GET surfaces/{surfaceId}

Request

No body
Path Param: surfaceId, java.lang.Integer

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.model.TimeSurfaceShort)
application/json: {"id":0,"params":{}}

404 Not Found

Response Body: (java.lang.String)

GET surfaces/{surfaceId}/differencetiles/{compareToSurfaceId}/{z}/{x}/{y}.png

Request

No body
Path Param: compareToSurfaceId, java.lang.Integer
Path Param: surfaceId, java.lang.Integer
Path Param: x, int
Path Param: y, int
Path Param: z, int

Response

Content-Type: image/geotiff

200 OK

Header: Cache-Control
Response Body: (org.opentripplanner.analyst.request.Renderer$2)
application/json: {}

400 Bad Request

Response Body: (java.lang.String)

GET surfaces/{surfaceId}/indicator

Request

No body
Path Param: surfaceId, java.lang.Integer
Query Param: detail, boolean
Query Param: origins, java.lang.String
Query Param: targets, java.lang.String

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.resource.SurfaceResource$1)
application/json: {}

400 Bad Request

Response Body: (java.lang.String)

GET surfaces/{surfaceId}/isochrone

Request

No body
Path Param: surfaceId, java.lang.Integer
Query Param: spacing, int

Response

Content-Type: application/json

200 OK

Response Body: (org.opentripplanner.api.resource.SurfaceResource$2)
application/json: {}

400 Bad Request

Response Body: (java.lang.String)

GET surfaces/{surfaceId}/isotiles/{z}/{x}/{y}.png

Request

No body
Path Param: surfaceId, java.lang.Integer
Path Param: x, int
Path Param: y, int
Path Param: z, int

Response

Content-Type: image/geotiff

200 OK

Header: Cache-Control
Response Body: (org.opentripplanner.analyst.request.Renderer$2)
application/json: {}

400 Bad Request

Response Body: (java.lang.String)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment