Created
March 7, 2020 23:15
-
-
Save SKalt/23c7c2729d7f57a54eeeae252e649b59 to your computer and use it in GitHub Desktop.
Openapi.yml built from OTP dev-1.x
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| info: | |
| title: "OpenTripPlanner" | |
| version: "1.5.0-SNAPSHOT" | |
| description: "<h1>OpenTripPlanner</h1><p>The OpenTripPlanner multimodal journey planning system</p>" | |
| license: | |
| name: "GNU Lesser General Public License" | |
| url: "https://www.gnu.org/licenses/lgpl-3.0.txt" | |
| servers: [] | |
| paths: | |
| "/patch/patch": | |
| post: | |
| description: "" | |
| tags: | |
| - "AlertPatcher" | |
| summary: "" | |
| deprecated: false | |
| operationId: createPatches | |
| requestBody: | |
| description: "" | |
| required: true | |
| content: | |
| "application/json": | |
| schema: | |
| $ref: "#/components/schemas/AlertPatchSet" | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/AlertPatchCreationResponse" | |
| "/patch/routePatches": | |
| get: | |
| description: "Return a list of all patches that apply to a given route" | |
| tags: | |
| - "AlertPatcher" | |
| summary: "Return a list of all patches that apply to a given route" | |
| deprecated: false | |
| operationId: getRoutePatches | |
| parameters: | |
| - name: "agency" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "id" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "Returns either an XML or a JSON document, depending on the HTTP Accept header of the\nclient making the request." | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/AlertPatchResponse" | |
| "/patch/stopPatches": | |
| get: | |
| description: "Return a list of all patches that apply to a given stop" | |
| tags: | |
| - "AlertPatcher" | |
| summary: "Return a list of all patches that apply to a given stop" | |
| deprecated: false | |
| operationId: getStopPatches | |
| parameters: | |
| - name: "agency" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "id" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "Returns either an XML or a JSON document, depending on the HTTP Accept header of the\nclient making the request." | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/AlertPatchResponse" | |
| "/routers/{routerId}/bike_rental": | |
| get: | |
| description: "" | |
| tags: | |
| - "BikeRental" | |
| summary: "" | |
| deprecated: false | |
| operationId: getBikeRentalStations | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "lowerLeft" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "upperRight" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/BikeRentalStationList" | |
| "/geocode": | |
| get: | |
| description: "" | |
| tags: | |
| - "ExternalGeocoderResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: geocode | |
| parameters: | |
| - name: "address" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bbox" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/geocode": | |
| get: | |
| description: "Geocode using data using the OTP graph for stops, clusters and street names" | |
| tags: | |
| - "GeocoderResource" | |
| summary: "Geocode using data using the OTP graph for stops, clusters and street names" | |
| deprecated: false | |
| operationId: textSearch | |
| parameters: | |
| - name: "autocomplete" | |
| in: query | |
| description: "Whether we should use the query string to do a prefix match" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "clusters" | |
| in: query | |
| description: "Search for clusters by their name" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "corners" | |
| in: query | |
| description: "Search for street corners using at least one of the street names" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "query" | |
| in: query | |
| description: "The query string we want to geocode" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "stops" | |
| in: query | |
| description: "Search for stops, either by name or stop code" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "list of results in in the format expected by GeocoderBuiltin.js in the OTP Leaflet client" | |
| content: | |
| "*/*": | |
| schema: | |
| description: "list of results in in the format expected by GeocoderBuiltin.js in the OTP Leaflet client" | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/inspector/layers": | |
| get: | |
| description: "Gets all layer names\n\nUsed in fronted to create layer chooser" | |
| tags: | |
| - "GraphInspectorTileResource" | |
| summary: "Gets all layer names\n\nUsed in fronted to create layer chooser" | |
| deprecated: false | |
| operationId: getLayers | |
| parameters: | |
| - name: "ext" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "layer" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "x" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "y" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "z" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/InspectorLayersList" | |
| "/routers/{routerId}/inspector/tile/{layer}/{z}/{x}/{y}.{ext}": | |
| get: | |
| description: "" | |
| tags: | |
| - "GraphInspectorTileResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: tileGet | |
| parameters: | |
| - name: "ext" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "layer" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "x" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "y" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "z" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/clusters": | |
| get: | |
| description: "Return all clusters of stops.\nA cluster is not the same thing as a GTFS parent station.\nClusters are an unsupported experimental feature that was added to assist in \"profile routing\".\nAs such the stop clustering method probably only works right with one or two GTFS data sets in the world." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return all clusters of stops." | |
| deprecated: false | |
| operationId: getAllStopClusters | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/feeds": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getFeeds | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/flexAreas": | |
| get: | |
| description: "Return all GTFS-Flex area IDs. Areas are defined in GTFS-Flex to be a lat/lon polygon in\nwhich certain kinds of flex service take place (deviated-route and call-and-ride)." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return all GTFS-Flex area IDs." | |
| deprecated: false | |
| operationId: getAllFlexAreas | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/graphql": | |
| post: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getGraphQL | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| requestBody: | |
| description: "" | |
| required: true | |
| content: | |
| "application/json": | |
| schema: | |
| type: string | |
| format: binary | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| post: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getGraphQL | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| requestBody: | |
| description: "" | |
| required: true | |
| content: | |
| "application/graphql": | |
| schema: | |
| type: string | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/patterns": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getPatterns | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/routes": | |
| get: | |
| description: "Return a list of all routes in the graph." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return a list of all routes in the graph." | |
| deprecated: false | |
| operationId: getRoutes | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "hasStop" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/services": | |
| get: | |
| description: "List basic information about all service IDs.\nThis is a placeholder endpoint and is not implemented yet." | |
| tags: | |
| - "IndexAPI" | |
| summary: "List basic information about all service IDs." | |
| deprecated: false | |
| operationId: getServices | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops": | |
| get: | |
| description: "Return a list of all stops within a circle around the given coordinate." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return a list of all stops within a circle around the given coordinate." | |
| deprecated: false | |
| operationId: getStopsInRadius | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "lat" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "lon" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxLat" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxLon" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minLat" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minLon" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "radius" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/agencies/{feedId}": | |
| get: | |
| description: "Return a list of all agencies in the graph." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return a list of all agencies in the graph." | |
| deprecated: false | |
| operationId: getAgencies | |
| parameters: | |
| - name: "feedId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/clusters/{clusterId}": | |
| get: | |
| description: "Return a cluster of stops by its ID.\nA cluster is not the same thing as a GTFS parent station.\nClusters are an unsupported experimental feature that was added to assist in \"profile routing\".\nAs such the stop clustering method probably only works right with one or two GTFS data sets in the world." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return a cluster of stops by its ID." | |
| deprecated: false | |
| operationId: getStopCluster | |
| parameters: | |
| - name: "clusterId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/feeds/{feedId}": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getFeedInfo | |
| parameters: | |
| - name: "feedId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/flexAreas/{id}": | |
| get: | |
| description: "Return a specific GTFS-Flex area given an ID in Agency:ID format." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return a specific GTFS-Flex area given an ID in Agency:ID format." | |
| deprecated: false | |
| operationId: getFlexAreaByFeedId | |
| parameters: | |
| - name: "id" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/patterns/{patternId}": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getPattern | |
| parameters: | |
| - name: "patternId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/routes/{routeId}": | |
| get: | |
| description: "Return specific route in the graph, for the given ID." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return specific route in the graph, for the given ID." | |
| deprecated: false | |
| operationId: getRoute | |
| parameters: | |
| - name: "routeId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/services/{serviceId}": | |
| get: | |
| description: "List details about a specific service ID including which dates it runs on. Replaces the old /calendar.\nThis is a placeholder endpoint and is not implemented yet." | |
| tags: | |
| - "IndexAPI" | |
| summary: "List details about a specific service ID including which dates it runs on." | |
| deprecated: false | |
| operationId: getServices | |
| parameters: | |
| - name: "serviceId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops/{stopId}": | |
| get: | |
| description: "Return specific transit stop in the graph, by ID." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return specific transit stop in the graph, by ID." | |
| deprecated: false | |
| operationId: getStop | |
| parameters: | |
| - name: "stopId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/trips/{tripId}": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getTrip | |
| parameters: | |
| - name: "tripId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/agencies/{feedId}/{agencyId}": | |
| get: | |
| description: "Return specific agency in the graph, by ID." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return specific agency in the graph, by ID." | |
| deprecated: false | |
| operationId: getAgency | |
| parameters: | |
| - name: "agencyId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "feedId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/patterns/{patternId}/geometry": | |
| get: | |
| description: "Return geometry for the pattern as a packed coordinate sequence" | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return geometry for the pattern as a packed coordinate sequence" | |
| deprecated: false | |
| operationId: getGeometryForPattern | |
| parameters: | |
| - name: "patternId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/patterns/{patternId}/semanticHash": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getSemanticHashForPattern | |
| parameters: | |
| - name: "patternId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/patterns/{patternId}/stops": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getStopsForPattern | |
| parameters: | |
| - name: "patternId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/patterns/{patternId}/trips": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getTripsForPattern | |
| parameters: | |
| - name: "patternId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/routes/{routeId}/patterns": | |
| get: | |
| description: "Return all stop patterns used by trips on the given route." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return all stop patterns used by trips on the given route." | |
| deprecated: false | |
| operationId: getPatternsForRoute | |
| parameters: | |
| - name: "routeId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/routes/{routeId}/stops": | |
| get: | |
| description: "Return all stops in any pattern on a given route." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return all stops in any pattern on a given route." | |
| deprecated: false | |
| operationId: getStopsForRoute | |
| parameters: | |
| - name: "routeId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/routes/{routeId}/trips": | |
| get: | |
| description: "Return all trips in any pattern on the given route." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return all trips in any pattern on the given route." | |
| deprecated: false | |
| operationId: getTripsForRoute | |
| parameters: | |
| - name: "routeId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops/{stopId}/patterns": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getPatternsForStop | |
| parameters: | |
| - name: "stopId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops/{stopId}/routes": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getRoutesForStop | |
| parameters: | |
| - name: "stopId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops/{stopId}/stoptimes": | |
| get: | |
| description: "Return upcoming vehicle arrival/departure times at the given stop." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return upcoming vehicle arrival/departure times at the given stop." | |
| deprecated: false | |
| operationId: getStoptimesForStop | |
| parameters: | |
| - name: "stopId" | |
| in: path | |
| description: "Stop ID in Agency:Stop ID format" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "numberOfDepartures" | |
| in: query | |
| description: "Number of departures to fetch per pattern" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "omitNonPickups" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTime" | |
| in: query | |
| description: "Start time for the search. Seconds from UNIX epoch" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "timeRange" | |
| in: query | |
| description: "Searches forward for timeRange seconds from startTime" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops/{stopId}/transfers": | |
| get: | |
| description: "Return the generated transfers a stop in the graph, by stop ID" | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return the generated transfers a stop in the graph, by stop ID" | |
| deprecated: false | |
| operationId: getTransfers | |
| parameters: | |
| - name: "stopId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/trips/{tripId}/geometry": | |
| get: | |
| description: "Return geometry for the trip as a packed coordinate sequence" | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return geometry for the trip as a packed coordinate sequence" | |
| deprecated: false | |
| operationId: getGeometryForTrip | |
| parameters: | |
| - name: "tripId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/trips/{tripId}/semanticHash": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getSemanticHashForTrip | |
| parameters: | |
| - name: "tripId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/trips/{tripId}/stops": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getStopsForTrip | |
| parameters: | |
| - name: "tripId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/trips/{tripId}/stoptimes": | |
| get: | |
| description: "" | |
| tags: | |
| - "IndexAPI" | |
| summary: "" | |
| deprecated: false | |
| operationId: getStoptimesForTrip | |
| parameters: | |
| - name: "tripId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/agencies/{feedId}/{agencyId}/routes": | |
| get: | |
| description: "Return all routes for the specific agency." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return all routes for the specific agency." | |
| deprecated: false | |
| operationId: getAgencyRoutes | |
| parameters: | |
| - name: "agencyId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "feedId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/index/stops/{stopId}/stoptimes/{date}": | |
| get: | |
| description: "Return upcoming vehicle arrival/departure times at the given stop." | |
| tags: | |
| - "IndexAPI" | |
| summary: "Return upcoming vehicle arrival/departure times at the given stop." | |
| deprecated: false | |
| operationId: getStoptimesForStopAndDate | |
| parameters: | |
| - name: "date" | |
| in: path | |
| description: "in YYYYMMDD format" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "stopId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "omitNonPickups" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/isochrone": | |
| get: | |
| description: "" | |
| tags: | |
| - "LIsochrone" | |
| summary: "" | |
| deprecated: false | |
| operationId: getGeoJsonIsochrone | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "coordinateOrigin" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "cutoffSec" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "debug" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTimeSec" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "offRoadDistanceMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "precisionMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| get: | |
| description: "" | |
| tags: | |
| - "LIsochrone" | |
| summary: "" | |
| deprecated: false | |
| operationId: getZippedShapefileIsochrone | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "coordinateOrigin" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "cutoffSec" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "debug" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTimeSec" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "offRoadDistanceMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "precisionMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "shpName" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "stream" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/analyst/legend.{format}": | |
| get: | |
| description: "" | |
| tags: | |
| - "LegendResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: tileGet2 | |
| parameters: | |
| - name: "format" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "height" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "styles" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "width" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/municoder": | |
| get: | |
| description: "" | |
| tags: | |
| - "MunicoderServer" | |
| summary: "" | |
| deprecated: false | |
| operationId: resolveLocation | |
| parameters: | |
| - name: "callback" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "location" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| "/routers/{routerId}/plan": | |
| get: | |
| description: "" | |
| tags: | |
| - "PlannerResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: plan | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/Response" | |
| "/pointsets": | |
| get: | |
| description: "" | |
| tags: | |
| - "PointSetResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: getAllPointSets | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/pointsets/{pointSetId}": | |
| get: | |
| description: "" | |
| tags: | |
| - "PointSetResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: getPointSet | |
| parameters: | |
| - name: "pointSetId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/profile": | |
| get: | |
| description: "" | |
| tags: | |
| - "ProfileResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: profileRoute | |
| parameters: | |
| - name: "accessModes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "analyst" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "banAgency" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bikeSafe" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSlope" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: float | |
| style: form | |
| - name: "bikeTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "carSpeed" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: float | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "directModes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "egressModes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "endTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "from" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "limit" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxBikeTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxCarTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "minBikeTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "minCarTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "orderBy" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| enum: | |
| - "AVG" | |
| - "MAX" | |
| - "MIN" | |
| type: string | |
| style: form | |
| - name: "startTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "streetTime" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "suboptimal" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "to" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transitModes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: float | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/rrtr": | |
| get: | |
| description: "" | |
| tags: | |
| - "RepeatedRaptorTestResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: profileRoute2 | |
| parameters: | |
| - name: "banAgency" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "banRoute" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "from" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "fromStop" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers": | |
| delete: | |
| description: "De-register all registered routerIds, evicting them from memory." | |
| tags: | |
| - "Routers" | |
| summary: "De-register all registered routerIds, evicting them from memory." | |
| deprecated: false | |
| operationId: deleteAll | |
| responses: | |
| "204": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| get: | |
| description: "Returns a list of routers and their bounds." | |
| tags: | |
| - "Routers" | |
| summary: "Returns a list of routers and their bounds." | |
| deprecated: false | |
| operationId: getRouterIds | |
| responses: | |
| "200": | |
| description: "a representation of the graphs and their geographic bounds, in JSON or XML depending\non the Accept header in the HTTP request." | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/RouterList" | |
| put: | |
| description: "Reload the graphs for all registered routerIds from disk." | |
| tags: | |
| - "Routers" | |
| summary: "Reload the graphs for all registered routerIds from disk." | |
| deprecated: false | |
| operationId: reloadGraphs | |
| parameters: | |
| - name: "force" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "path" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preEvict" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "204": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/save": | |
| post: | |
| description: "Save the graph data, but don't load it in memory. The file location is based on routerId.\nIf the graph already exists, the graph will be overwritten." | |
| tags: | |
| - "Routers" | |
| summary: "Save the graph data, but don't load it in memory." | |
| deprecated: false | |
| operationId: saveGraphOverWire | |
| parameters: | |
| - name: "routerId" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| requestBody: | |
| description: "" | |
| required: true | |
| content: | |
| "application/octet-stream": | |
| schema: | |
| type: string | |
| format: binary | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| "/routers/{routerId}": | |
| delete: | |
| description: "De-register a specific routerId, evicting the associated graph from memory." | |
| tags: | |
| - "Routers" | |
| summary: "De-register a specific routerId, evicting the associated graph from memory." | |
| deprecated: false | |
| operationId: deleteGraphId | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| responses: | |
| "204": | |
| description: "status code 200 if the routerId was de-registered,\n404 if the routerId was not registered." | |
| content: | |
| "*/*": | |
| schema: | |
| description: "status code 200 if the routerId was de-registered,\n404 if the routerId was not registered." | |
| type: string | |
| get: | |
| description: "Returns the bounds for a specific routerId, or verifies whether it is registered." | |
| tags: | |
| - "Routers" | |
| summary: "Returns the bounds for a specific routerId, or verifies whether it is registered." | |
| deprecated: false | |
| operationId: getGraphId | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/RouterInfo" | |
| post: | |
| description: "Deserialize a graph sent with the HTTP request as POST data, associating it with the given\nrouterId." | |
| tags: | |
| - "Routers" | |
| summary: "Deserialize a graph sent with the HTTP request as POST data, associating it with the given\nrouterId." | |
| deprecated: false | |
| operationId: postGraphOverWire | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "preEvict" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| requestBody: | |
| description: "" | |
| required: true | |
| content: | |
| "application/octet-stream": | |
| schema: | |
| type: string | |
| format: binary | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| post: | |
| description: "Build a graph from data in the ZIP file posted over the wire, associating it with the given router ID.\nThis method will be selected when the Content-Type is application/zip." | |
| tags: | |
| - "Routers" | |
| summary: "Build a graph from data in the ZIP file posted over the wire, associating it with the given router ID." | |
| deprecated: false | |
| operationId: buildGraphOverWire | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "preEvict" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| requestBody: | |
| description: "" | |
| required: true | |
| content: | |
| "application/zip": | |
| schema: | |
| type: string | |
| format: binary | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| put: | |
| description: "Load the graph for the specified routerId from disk." | |
| tags: | |
| - "Routers" | |
| summary: "Load the graph for the specified routerId from disk." | |
| deprecated: false | |
| operationId: putGraphId | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "preEvict" | |
| in: query | |
| description: "before reloading each graph, evict the existing graph. This will prevent\nmemory usage from increasing during the reload, but routing will be unavailable on this\nrouterId for the duration of the operation." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "204": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| "/routers/{routerId}/isochroneOld": | |
| get: | |
| description: "Calculates walksheds for a given location, based on time given to walk and the walk speed.\n\nDepending on the value for the \"output\" parameter (i.e. \"POINTS\", \"SHED\" or \"EDGES\"), a\ndifferent type of GeoJSON geometry is returned. If a SHED is requested, then a ConcaveHull\nof the EDGES/roads is returned. If that fails, a ConvexHull will be returned.\n<p>\nThe ConcaveHull parameter is set to 0.005 degrees. The offroad walkspeed is assumed to be\n0.83333 m/sec (= 3km/h) until a road is hit.\n<p>\nNote that the set of EDGES/roads returned as well as POINTS returned may contain duplicates.\nIf POINTS are requested, then not the end-points are returned at which the max time is\nreached, but instead all the graph nodes/crossings that are within the time limits.\n<p>\nIn case there is no road near by within the given time, then a circle for the walktime limit\nis created and returned for the SHED parameter. Otherwise the edge with the direction\ntowards the closest road. Note that the circle is calculated in Euclidian 2D coordinates,\nand distortions towards an ellipse will appear if it is transformed/projected to the user location.\n<p>\nAn example request may look like this:\nlocalhost:8080/otp-rest-servlet/ws/iso?layers=traveltime&styles=mask&batch=true&fromPlace=51.040193121307176\n%2C-114.04471635818481&toPlace\n=51.09098935%2C-113.95179705&time=2012-06-06T08%3A00%3A00&mode=WALK&maxWalkDistance=10000&walkSpeed=1.38&walkTime=10.7&output=EDGES\nThough the first parameters (i) layer, (ii) styles and (iii) batch could be discarded." | |
| tags: | |
| - "SIsochrone" | |
| summary: "Calculates walksheds for a given location, based on time given to walk and the walk speed." | |
| deprecated: false | |
| operationId: getIsochrone | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "output" | |
| in: query | |
| description: "Can be set to \"POINTS\", \"SHED\" or \"EDGES\" to return different types of GeoJSON\ngeometry. SHED returns a ConcaveHull or ConvexHull of the edges/roads. POINTS returns\nall graph nodes that are within the time limit." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkTime" | |
| in: query | |
| description: "Maximum number of minutes to walk." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "a JSON document containing geometries (either points, lineStrings or a polygon)." | |
| content: | |
| "*/*": | |
| schema: | |
| description: "a JSON document containing geometries (either points, lineStrings or a polygon)." | |
| type: string | |
| "/routers/{routerId}/scenarios": | |
| get: | |
| description: "Return a list of all scenarios defined for this router." | |
| tags: | |
| - "ScenarioResource" | |
| summary: "Return a list of all scenarios defined for this router." | |
| deprecated: false | |
| operationId: getScenarioDescriptions | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/scenarios/{scenarioId}": | |
| get: | |
| description: "Return specific scenario defined for this router by ID." | |
| tags: | |
| - "ScenarioResource" | |
| summary: "Return specific scenario defined for this router by ID." | |
| deprecated: false | |
| operationId: getScenario | |
| parameters: | |
| - name: "scenarioId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "refs" | |
| in: query | |
| description: "Include GTFS entities referenced by ID in the result." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "": | |
| get: | |
| description: "" | |
| tags: | |
| - "ServerInfo" | |
| summary: "" | |
| deprecated: false | |
| operationId: getServerInfo | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/ServerInfo" | |
| "/routers/{routerId}/simpleIsochrone": | |
| get: | |
| description: "" | |
| tags: | |
| - "SimpleIsochrone" | |
| summary: "" | |
| deprecated: false | |
| operationId: geoJsonGet | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "contourSpacingMinutes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "crs" | |
| in: query | |
| description: "The coordinate reference system in which buffering should be performed.\nDefaults to the Hong Kong 1980 Grid System." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nContours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "radiusMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "requestSpacingMinutes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "requestTimespanHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "resultsProjected" | |
| in: query | |
| description: "Whether the results should be left in the indicated CRS or de-projected back to WGS84." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "shpName" | |
| in: query | |
| description: "What to name the output file." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "stopsOnly" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "Evenly spaced travel time contours (isochrones) as GeoJSON." | |
| content: | |
| "*/*": | |
| schema: | |
| description: "Evenly spaced travel time contours (isochrones) as GeoJSON." | |
| type: string | |
| format: binary | |
| get: | |
| description: "" | |
| tags: | |
| - "SimpleIsochrone" | |
| summary: "" | |
| deprecated: false | |
| operationId: zippedShapefileGet | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "contourSpacingMinutes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "crs" | |
| in: query | |
| description: "The coordinate reference system in which buffering should be performed.\nDefaults to the Hong Kong 1980 Grid System." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nContours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "radiusMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "requestSpacingMinutes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "requestTimespanHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "resultsProjected" | |
| in: query | |
| description: "Whether the results should be left in the indicated CRS or de-projected back to WGS84." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "shpName" | |
| in: query | |
| description: "What to name the output file." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "stopsOnly" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "stream" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "Evenly spaced travel time contours (isochrones) as a zipped shapefile." | |
| content: | |
| "*/*": | |
| schema: | |
| description: "Evenly spaced travel time contours (isochrones) as a zipped shapefile." | |
| type: string | |
| format: binary | |
| "/surfaces": | |
| get: | |
| description: "List all the available surfaces." | |
| tags: | |
| - "SurfaceResource" | |
| summary: "List all the available surfaces." | |
| deprecated: false | |
| operationId: getTimeSurfaceList | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| post: | |
| description: "" | |
| tags: | |
| - "SurfaceResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: createSurface | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "cutoffMinutes" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "routerId" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "201": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/surfaces/{surfaceId}": | |
| get: | |
| description: "Describe a specific surface." | |
| tags: | |
| - "SurfaceResource" | |
| summary: "Describe a specific surface." | |
| deprecated: false | |
| operationId: getTimeSurfaceList | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "surfaceId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/surfaces/{surfaceId}/indicator": | |
| get: | |
| description: "Evaluate a surface at all the points in a PointSet.\nThis sends back a ResultSet serialized as JSON.\nNormally we return historgrams with the number of points reached (in field 'counts') and the number of\nopportunities reached (i.e. the sum of the magnitudes of all points reached) in each one-minute bin of travel\ntime." | |
| tags: | |
| - "SurfaceResource" | |
| summary: "Evaluate a surface at all the points in a PointSet." | |
| deprecated: false | |
| operationId: getIndicator | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "surfaceId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "detail" | |
| in: query | |
| description: "if true, include the travel time to every point in the pointset (which is in fact an ordered list)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "origins" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "targets" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/surfaces/{surfaceId}/isochrone": | |
| get: | |
| description: "Create vector isochrones for a surface." | |
| tags: | |
| - "SurfaceResource" | |
| summary: "Create vector isochrones for a surface." | |
| deprecated: false | |
| operationId: getIsochrone2 | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "surfaceId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nMax" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "spacing" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/surfaces/{surfaceId}/raster": | |
| get: | |
| description: "Produce a single grayscale raster of travel time, like travel time tiles but not broken into tiles." | |
| tags: | |
| - "SurfaceResource" | |
| summary: "Produce a single grayscale raster of travel time, like travel time tiles but not broken into tiles." | |
| deprecated: false | |
| operationId: getRaster | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "surfaceId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "crs" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "format" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "height" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "resolution" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "width" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/surfaces/{surfaceId}/isotiles/{z}/{x}/{y}.png": | |
| get: | |
| description: "" | |
| tags: | |
| - "SurfaceResource" | |
| summary: "" | |
| deprecated: false | |
| operationId: tileGet3 | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "surfaceId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "x" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "y" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "z" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/surfaces/{surfaceId}/differencetiles/{compareToSurfaceId}/{z}/{x}/{y}.png": | |
| get: | |
| description: "Renders a raster tile for showing the difference between two TimeSurfaces.\nThis service is included as a way to provide difference tiles using existing mechanisms in OTP.\nTODO However, there is some room for debate around how differences are expressed in URLs.\nWe may want a more general purpose mechanism for combining time surfaces.\nFor example you could make a web service request to create a time surface A-B or A+B, and the server would give\nyou an ID for that surface, and then you could use that ID anywhere a surface ID is required. Perhaps internally\nthere would be some sort of DifferenceTimeSurface subclass that could just drop in anywhere TimeSurface is used.\nThis approach would be more stateful but more flexible." | |
| tags: | |
| - "SurfaceResource" | |
| summary: "Renders a raster tile for showing the difference between two TimeSurfaces." | |
| deprecated: false | |
| operationId: differenceTileGet | |
| parameters: | |
| - name: "compareToSurfaceId" | |
| in: path | |
| description: "The id of of the surface, which is compared to the first surface" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "surfaceId" | |
| in: path | |
| description: "The id of the first surface" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "x" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "y" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "z" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/analyst/tile/{z}/{x}/{y}.png": | |
| get: | |
| description: "" | |
| tags: | |
| - "TileService" | |
| summary: "" | |
| deprecated: false | |
| operationId: tileGet4 | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "x" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "y" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "z" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "format" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "layers" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "styles" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/timegrid": | |
| get: | |
| description: "" | |
| tags: | |
| - "TimeGridWs" | |
| summary: "" | |
| deprecated: false | |
| operationId: getTimeGridPng | |
| parameters: | |
| - name: "routerId" | |
| in: path | |
| description: "The routerId selects between several graphs on the same server. The routerId is pulled from\nthe path, not the query parameters. However, the class RoutingResource is not annotated with\na path because we don't want it to be instantiated as an endpoint. Instead, the {routerId}\npath parameter should be included in the path annotations of all its subclasses." | |
| required: true | |
| schema: | |
| type: string | |
| style: simple | |
| - name: "alightSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "arriveBy" | |
| in: query | |
| description: "Whether the trip should depart or arrive at the specified date and time." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bannedAgencies" | |
| in: query | |
| description: "The comma-separated list of banned agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedRoutes" | |
| in: query | |
| description: "The comma-separated list of banned routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42\n(two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStops" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. Also, it is still possible to travel through the stop. Just\nboarding and alighting is prohibited.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedStopsHard" | |
| in: query | |
| description: "A comma-separated list of banned stops. A stop is banned by ignoring its\npre-board and pre-alight edges. This means the stop will be reachable via the\nstreet network. It is not possible to travel through the stop.\nFor example, this parameter can be used when a train station is destroyed, such\nthat no trains can drive through the station anymore.\nThe format is agencyId_stopId, so: TriMet_2107" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "bannedTrips" | |
| in: query | |
| description: "The comma-separated list of banned trips. The format is agency_trip[:stop*], so:\nTriMet_24601 or TriMet_24601:0:1:2:17:18:19" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "base64" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "batch" | |
| in: query | |
| description: "If true, goal direction is turned off and a full path tree is built (specify only once)" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "bikeBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while cycling. This is usually higher that walkBoardCost." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSpeed" | |
| in: query | |
| description: "The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "bikeSwitchCost" | |
| in: query | |
| description: "The cost of the user fetching their bike and parking it again.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "bikeSwitchTime" | |
| in: query | |
| description: "The time it takes the user to fetch their bike and park it again in seconds.\nDefaults to 0." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "boardSlack" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "clampInitialWait" | |
| in: query | |
| description: "When subtracting initial wait time, do not subtract more than this value, to prevent overly\noptimistic trips. Reasoning is that it is reasonable to delay a trip start 15 minutes to\nmake a better trip, but that it is not reasonable to delay a trip start 15 hours; if that\nis to be done, the time needs to be included in the trip time. This number depends on the\ntransit system; for transit systems where trips are planned around the vehicles, this number\ncan be much higher. For instance, it's perfectly reasonable to delay one's trip 12 hours if\none is taking a cross-country Amtrak train from Emeryville to Chicago. Has no effect in\nstock OTP, only in Analyst.\n\nA value of 0 means that initial wait time will not be subtracted out (will be clamped to 0).\nA value of -1 (the default) means that clamping is disabled, so any amount of initial wait\ntime will be subtracted out." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| style: form | |
| - name: "coordinateOrigin" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "date" | |
| in: query | |
| description: "The date that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "disableAlertFiltering" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "disableRemainingWeightHeuristic" | |
| in: query | |
| description: "If true, the remaining weight heuristic is disabled. Currently only implemented for the long\ndistance path service." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexFlagStopBufferSize" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "flexIgnoreDrtAdvanceBookMin" | |
| in: query | |
| description: "Whether to ignore DRT time limits.\n\nAccording to the GTFS-flex spec, demand-response transit (DRT) service must be reserved\nat least `drt_advance_book_min` minutes in advance. OTP not allow DRT service to be used\ninside that time window, unless this parameter is set to true." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseEligibilityServices" | |
| in: query | |
| description: "Whether to use eligibility-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "flexUseReservationServices" | |
| in: query | |
| description: "Whether to use reservation-based services" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "fromPlace" | |
| in: query | |
| description: "The start location -- either latitude, longitude pair in degrees or a Vertex\nlabel. For example, <code>40.714476,-74.005966</code> or\n<code>mtanyctsubway_A27_S</code>." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "geoidElevation" | |
| in: query | |
| description: "If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "ignoreRealtimeUpdates" | |
| in: query | |
| description: "If true, realtime updates are ignored during this search." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "intermediatePlaces" | |
| in: query | |
| description: "An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times." | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| - name: "locale" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "maxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "maxPreTransitTime" | |
| in: query | |
| description: "The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and\nride or kiss and ride). Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTimeSec" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxTransfers" | |
| in: query | |
| description: "The maximum number of transfers (that is, one plus the maximum number of boardings)\nthat a trip will be allowed. Larger values will slow performance, but could give\nbetter routes. This is limited on the server side by the MAX_TRANSFERS value in\norg.opentripplanner.api.ws.Planner." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "maxWalkDistance" | |
| in: query | |
| description: "The maximum distance (in meters) the user is willing to walk. Defaults to unlimited." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "minTransferTime" | |
| in: query | |
| description: "The minimum time, in seconds, between successive trips on different vehicles.\nThis is designed to allow for imperfect schedule adherence. This is a minimum;\ntransfers over longer distances might use a longer time." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "mode" | |
| in: query | |
| description: "<p>The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.</p>\n<p>The possible values of the comma-separated list are:</p>\n\n<ul>\n<li>WALK</li>\n<li>TRANSIT</li>\n<li>BICYCLE</li>\n<li>BICYCLE_RENT</li>\n<li>BICYCLE_PARK</li>\n<li>CAR</li>\n<li>CAR_PARK</li>\n<li>TRAM</li>\n<li>SUBWAY</li>\n<li>RAIL</li>\n<li>BUS</li>\n<li>CABLE_CAR</li>\n<li>FERRY</li>\n<li>GONDOLA</li>\n<li>FUNICULAR</li>\n<li>AIRPLANE</li>\n</ul>\n\n<p>\nFor a more complete discussion of this parameter see <a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>.\n</p>" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "nonpreferredTransferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first when the transfer is not\npreferred. Preferred transfers also include timed transfers. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers that are not preferred. Of course, transfers that save\nsignificant time or walking will still be taken.\nWhen no preferred or timed transfer is defined, this value is ignored." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "numItineraries" | |
| in: query | |
| description: "The maximum number of possible itineraries to return." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "offRoadDistanceMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "optimize" | |
| in: query | |
| description: "The set of characteristics that the user wants to optimize for. @See OptimizeType" | |
| required: false | |
| schema: | |
| enum: | |
| - "FLAT" | |
| - "GREENWAYS" | |
| - "QUICK" | |
| - "SAFE" | |
| - "TRANSFERS" | |
| - "TRIANGLE" | |
| type: string | |
| style: form | |
| - name: "otherThanPreferredRoutesPenalty" | |
| in: query | |
| description: "Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing\nto wait for preferred route." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "pathComparator" | |
| in: query | |
| description: "Set the method of sorting itineraries in the response. Right now, the only supported value is \"duration\";\notherwise it uses default sorting. More sorting methods may be added in the future." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "precisionMeters" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "preferredAgencies" | |
| in: query | |
| description: "The comma-separated list of preferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "preferredRoutes" | |
| in: query | |
| description: "The list of preferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name)\nor Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization\nwill occur once a trip has been chosen (in Analyst, it will not be done at all)." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "showIntermediateStops" | |
| in: query | |
| description: "Whether intermediate stops -- those that the itinerary passes in a vehicle, but\ndoes not board or alight at -- should be returned in the response. For example,\non a Q train trip from Prospect Park to DeKalb Avenue, whether 7th Avenue and\nAtlantic Avenue should be included." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "startTransitStopId" | |
| in: query | |
| description: "A transit stop required to be the first stop in the search (AgencyId_StopId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "startTransitTripId" | |
| in: query | |
| description: "A transit trip acting as a starting \"state\" for depart-onboard routing (AgencyId_TripId)" | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "time" | |
| in: query | |
| description: "The time that the trip should depart (or arrive, for requests where arriveBy is true)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "toPlace" | |
| in: query | |
| description: "The end location (see fromPlace for format)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "transferPenalty" | |
| in: query | |
| description: "An additional penalty added to boardings after the first. The value is in OTP's\ninternal weight units, which are roughly equivalent to seconds. Set this to a high\nvalue to discourage transfers. Of course, transfers that save significant\ntime or walking will still be taken." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "triangleSafetyFactor" | |
| in: query | |
| description: "For bike triangle routing, how much safety matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleSlopeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much slope matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "triangleTimeFactor" | |
| in: query | |
| description: "For bike triangle routing, how much time matters (range 0-1)." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "unpreferredAgencies" | |
| in: query | |
| description: "The comma-separated list of unpreferred agencies." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "unpreferredRoutes" | |
| in: query | |
| description: "The list of unpreferred routes. The format is agency_[routename][_routeid], so TriMet_100 (100 is route short name) or Trimet__42 (two\nunderscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "useRequestedDateTimeInMaxHours" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "waitAtBeginningFactor" | |
| in: query | |
| description: "How much less bad is waiting at the beginning of the trip (replaces waitReluctance)" | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "waitReluctance" | |
| in: query | |
| description: "How much worse is waiting for a transit vehicle than being on a transit vehicle, as a\nmultiplier. The default value treats wait and on-vehicle time as the same.\n\nIt may be tempting to set this higher than walkReluctance (as studies often find this kind of\npreferences among riders) but the planner will take this literally and walk down a transit\nline to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make\nwaiting offboard preferable to waiting onboard in an interlined trip. That is also\nundesirable.\n\nIf we only tried the shortest possible transfer at each stop to neighboring stop patterns,\nthis problem could disappear." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkBoardCost" | |
| in: query | |
| description: "Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that\nis used when boarding while walking." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: form | |
| - name: "walkReluctance" | |
| in: query | |
| description: "A multiplier for how bad walking is, compared to being in transit for equal lengths of time.\nDefaults to 2. Empirically, values between 10 and 20 seem to correspond well to the concept\nof not wanting to walk too much without asking for totally ridiculous itineraries, but this\nobservation should in no way be taken as scientific or definitive. Your mileage may vary." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "walkSpeed" | |
| in: query | |
| description: "The user's walking speed in meters/second. Defaults to approximately 3 MPH." | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| style: form | |
| - name: "wheelchair" | |
| in: query | |
| description: "Whether the trip must be wheelchair accessible." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| - name: "whiteListedAgencies" | |
| in: query | |
| description: "Functions the same as banned agencies, except only the listed agencies are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "whiteListedRoutes" | |
| in: query | |
| description: "Functions the same as bannnedRoutes, except only the listed routes are allowed." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "zDataType" | |
| in: query | |
| description: "" | |
| required: false | |
| schema: | |
| enum: | |
| - "BOARDINGS" | |
| - "TIME" | |
| - "WALK_DISTANCE" | |
| type: string | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/updaters": | |
| get: | |
| description: "Return a list of all agencies in the graph." | |
| tags: | |
| - "UpdaterStatusResource" | |
| summary: "Return a list of all agencies in the graph." | |
| deprecated: false | |
| operationId: getUpdaters | |
| parameters: | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| "/routers/{routerId}/updaters/{updaterId}": | |
| get: | |
| description: "Return status for a specific updater." | |
| tags: | |
| - "UpdaterStatusResource" | |
| summary: "Return status for a specific updater." | |
| deprecated: false | |
| operationId: getUpdaters | |
| parameters: | |
| - name: "updaterId" | |
| in: path | |
| description: "" | |
| required: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| style: simple | |
| - name: "detail" | |
| in: query | |
| description: "Choose short or long form of results." | |
| required: false | |
| schema: | |
| type: boolean | |
| style: form | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| type: string | |
| format: binary | |
| components: | |
| schemas: | |
| "AbsoluteDirection": | |
| title: "AbsoluteDirection" | |
| type: string | |
| enum: | |
| - "NORTH" | |
| - "NORTHEAST" | |
| - "EAST" | |
| - "SOUTHEAST" | |
| - "SOUTH" | |
| - "SOUTHWEST" | |
| - "WEST" | |
| - "NORTHWEST" | |
| "Alert": | |
| title: "Alert" | |
| type: object | |
| properties: | |
| "alertHeaderText": | |
| $ref: "#/components/schemas/I18NString" | |
| "alertDescriptionText": | |
| $ref: "#/components/schemas/I18NString" | |
| "alertUrl": | |
| $ref: "#/components/schemas/I18NString" | |
| "effectiveStartDate": | |
| type: integer | |
| format: int32 | |
| "effectiveEndDate": | |
| type: integer | |
| format: int32 | |
| example: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| "AlertPatch": | |
| title: "AlertPatch" | |
| type: object | |
| required: | |
| - "directionId" | |
| properties: | |
| "alert": | |
| $ref: "#/components/schemas/Alert" | |
| "id": | |
| type: string | |
| "agency": | |
| type: string | |
| "route": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "trip": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "stop": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "direction": | |
| type: string | |
| "directionId": | |
| type: integer | |
| format: int32 | |
| "feedId": | |
| type: string | |
| example: | |
| alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| id: "..." | |
| agency: "..." | |
| route: | |
| agencyId: "..." | |
| id: "..." | |
| trip: | |
| agencyId: "..." | |
| id: "..." | |
| stop: | |
| agencyId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| "AlertPatchCreationResponse": | |
| title: "AlertPatchCreationResponse" | |
| type: object | |
| properties: | |
| "status": | |
| type: string | |
| example: | |
| status: "..." | |
| "AlertPatchResponse": | |
| title: "AlertPatchResponse" | |
| type: object | |
| properties: | |
| "alertPatches": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/AlertPatch" | |
| example: | |
| alertPatches: | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| id: "..." | |
| agency: "..." | |
| route: | |
| agencyId: "..." | |
| id: "..." | |
| trip: | |
| agencyId: "..." | |
| id: "..." | |
| stop: | |
| agencyId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| id: "..." | |
| agency: "..." | |
| route: | |
| agencyId: "..." | |
| id: "..." | |
| trip: | |
| agencyId: "..." | |
| id: "..." | |
| stop: | |
| agencyId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| "AlertPatchSet": | |
| title: "AlertPatchSet" | |
| type: object | |
| properties: | |
| "alertPatches": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/AlertPatch" | |
| example: | |
| alertPatches: | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| id: "..." | |
| agency: "..." | |
| route: | |
| agencyId: "..." | |
| id: "..." | |
| trip: | |
| agencyId: "..." | |
| id: "..." | |
| stop: | |
| agencyId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| id: "..." | |
| agency: "..." | |
| route: | |
| agencyId: "..." | |
| id: "..." | |
| trip: | |
| agencyId: "..." | |
| id: "..." | |
| stop: | |
| agencyId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| "BikeRentalStation": | |
| title: "BikeRentalStation" | |
| type: object | |
| required: | |
| - "y" | |
| - "x" | |
| - "bikesAvailable" | |
| - "spacesAvailable" | |
| - "allowDropoff" | |
| - "isFloatingBike" | |
| - "isCarStation" | |
| - "realTimeData" | |
| properties: | |
| "id": | |
| type: string | |
| "y": | |
| type: number | |
| format: double | |
| "x": | |
| type: number | |
| format: double | |
| "bikesAvailable": | |
| type: integer | |
| format: int32 | |
| "spacesAvailable": | |
| type: integer | |
| format: int32 | |
| "allowDropoff": | |
| type: boolean | |
| "isFloatingBike": | |
| type: boolean | |
| "isCarStation": | |
| type: boolean | |
| "networks": | |
| description: "List of compatible network names. Null (default) to be compatible with all." | |
| type: array | |
| items: | |
| type: string | |
| "realTimeData": | |
| description: "Whether this station is static (usually coming from OSM data) or a real-time source. If no real-time data, users should take\nbikesAvailable/spacesAvailable with a pinch of salt, as they are always the total capacity divided by two. Only the total is meaningful." | |
| type: boolean | |
| "name": | |
| description: "Gets translated name of bike rental station based on locale" | |
| type: string | |
| example: | |
| id: "..." | |
| y: 12345.0 | |
| x: 12345.0 | |
| bikesAvailable: 12345 | |
| spacesAvailable: 12345 | |
| allowDropoff: true | |
| isFloatingBike: true | |
| isCarStation: true | |
| networks: | |
| - "..." | |
| - "..." | |
| realTimeData: true | |
| name: "..." | |
| "BikeRentalStationList": | |
| title: "BikeRentalStationList" | |
| type: object | |
| properties: | |
| "stations": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/BikeRentalStation" | |
| example: | |
| stations: | |
| - id: "..." | |
| y: 12345.0 | |
| x: 12345.0 | |
| bikesAvailable: 12345 | |
| spacesAvailable: 12345 | |
| allowDropoff: true | |
| isFloatingBike: true | |
| isCarStation: true | |
| networks: | |
| - "..." | |
| - "..." | |
| realTimeData: true | |
| name: "..." | |
| - id: "..." | |
| y: 12345.0 | |
| x: 12345.0 | |
| bikesAvailable: 12345 | |
| spacesAvailable: 12345 | |
| allowDropoff: true | |
| isFloatingBike: true | |
| isCarStation: true | |
| networks: | |
| - "..." | |
| - "..." | |
| realTimeData: true | |
| name: "..." | |
| "BoardAlightType": | |
| title: "BoardAlightType" | |
| type: string | |
| enum: | |
| - "DEFAULT" | |
| - "FLAG_STOP" | |
| - "DEVIATED" | |
| "Coordinate": | |
| title: "Coordinate" | |
| type: object | |
| required: | |
| - "m" | |
| - "x" | |
| - "y" | |
| - "z" | |
| properties: | |
| "m": | |
| type: number | |
| format: double | |
| "x": | |
| type: number | |
| format: double | |
| "y": | |
| type: number | |
| format: double | |
| "z": | |
| type: number | |
| format: double | |
| example: | |
| m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| "CoordinateArrayListSequence": | |
| title: "CoordinateArrayListSequence" | |
| type: object | |
| required: | |
| - "dimension" | |
| properties: | |
| "dimension": | |
| type: integer | |
| format: int32 | |
| example: | |
| dimension: 12345 | |
| "CoordinateSequence": | |
| oneOf: | |
| - $ref: "#/components/schemas/CoordinateArrayListSequence" | |
| - $ref: "#/components/schemas/PackedCoordinateSequence" | |
| "CoordinateSequenceFactory": | |
| oneOf: | |
| - $ref: "#/components/schemas/Serializable2DPackedCoordinateSequenceFactory" | |
| "DebugOutput": | |
| title: "DebugOutput" | |
| type: object | |
| required: | |
| - "precalculationTime" | |
| - "pathCalculationTime" | |
| - "renderingTime" | |
| - "totalTime" | |
| - "timedOut" | |
| properties: | |
| "precalculationTime": | |
| type: integer | |
| format: int64 | |
| "pathCalculationTime": | |
| type: integer | |
| format: int64 | |
| "pathTimes": | |
| type: array | |
| items: | |
| type: integer | |
| format: int64 | |
| "renderingTime": | |
| type: integer | |
| format: int64 | |
| "totalTime": | |
| type: integer | |
| format: int64 | |
| "timedOut": | |
| type: boolean | |
| example: | |
| precalculationTime: 12345 | |
| pathCalculationTime: 12345 | |
| pathTimes: | |
| - 12345 | |
| - 12345 | |
| renderingTime: 12345 | |
| totalTime: 12345 | |
| timedOut: true | |
| "ElevationMetadata": | |
| title: "ElevationMetadata" | |
| type: object | |
| properties: | |
| "ellipsoidToGeoidDifference": | |
| type: number | |
| "geoidElevation": | |
| type: boolean | |
| example: | |
| ellipsoidToGeoidDifference: 12345.0 | |
| geoidElevation: true | |
| "EncodedPolylineBean": | |
| title: "EncodedPolylineBean" | |
| type: object | |
| required: | |
| - "length" | |
| properties: | |
| "points": | |
| description: "The encoded points of the polyline." | |
| type: string | |
| "levels": | |
| description: "Levels describes which points should be shown at various zoom levels. Presently, we show all\npoints at all zoom levels." | |
| type: string | |
| "length": | |
| description: "The number of points in the string" | |
| type: integer | |
| format: int32 | |
| example: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| "EntryOfStringAndString": | |
| title: "EntryOfStringAndString" | |
| type: object | |
| properties: | |
| "value": | |
| type: string | |
| "key": | |
| type: string | |
| example: | |
| value: "..." | |
| key: "..." | |
| "Envelope": | |
| title: "Envelope" | |
| type: object | |
| required: | |
| - "maxX" | |
| - "null" | |
| - "area" | |
| - "maxY" | |
| - "height" | |
| - "width" | |
| - "minX" | |
| - "minY" | |
| properties: | |
| "maxX": | |
| type: number | |
| format: double | |
| "null": | |
| type: boolean | |
| "area": | |
| type: number | |
| format: double | |
| "maxY": | |
| type: number | |
| format: double | |
| "height": | |
| type: number | |
| format: double | |
| "width": | |
| type: number | |
| format: double | |
| "minX": | |
| type: number | |
| format: double | |
| "minY": | |
| type: number | |
| format: double | |
| example: | |
| maxX: 12345.0 | |
| null: true | |
| area: 12345.0 | |
| maxY: 12345.0 | |
| height: 12345.0 | |
| width: 12345.0 | |
| minX: 12345.0 | |
| minY: 12345.0 | |
| "Fare": | |
| title: "Fare" | |
| type: object | |
| properties: | |
| "fare": | |
| description: "A mapping from FareType to Money." | |
| type: object | |
| additionalProperties: | |
| $ref: "#/components/schemas/Money" | |
| "details": | |
| description: "A mapping from FareType to a list of FareComponent.\nThe FareComponents are stored in an array instead of a list because JAXB doesn't know how to deal with\ninterfaces when serializing a trip planning response, and List is an interface.\nSee https://stackoverflow.com/a/1119241/778449" | |
| type: object | |
| additionalProperties: | |
| $ref: "#/components/schemas/FareComponent" | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/FareComponent" | |
| example: | |
| fare: | |
| property1: | |
| currency: | |
| defaultFractionDigits: 12345 | |
| currencyCode: "..." | |
| symbol: "..." | |
| currency: "..." | |
| cents: 12345 | |
| property2: | |
| currency: | |
| defaultFractionDigits: 12345 | |
| currencyCode: "..." | |
| symbol: "..." | |
| currency: "..." | |
| cents: 12345 | |
| details: | |
| property1: | |
| - fareId: | |
| agencyId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - agencyId: "..." | |
| id: "..." | |
| - agencyId: "..." | |
| id: "..." | |
| - fareId: | |
| agencyId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - agencyId: "..." | |
| id: "..." | |
| - agencyId: "..." | |
| id: "..." | |
| property2: | |
| - fareId: | |
| agencyId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - agencyId: "..." | |
| id: "..." | |
| - agencyId: "..." | |
| id: "..." | |
| - fareId: | |
| agencyId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - agencyId: "..." | |
| id: "..." | |
| - agencyId: "..." | |
| id: "..." | |
| "FareComponent": | |
| title: "FareComponent" | |
| type: object | |
| properties: | |
| "fareId": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "price": | |
| $ref: "#/components/schemas/Money" | |
| "routes": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/FeedScopedId" | |
| example: | |
| fareId: | |
| agencyId: "..." | |
| id: "..." | |
| price: | |
| currency: | |
| defaultFractionDigits: 12345 | |
| currencyCode: "..." | |
| symbol: "..." | |
| currency: "..." | |
| cents: 12345 | |
| routes: | |
| - agencyId: "..." | |
| id: "..." | |
| - agencyId: "..." | |
| id: "..." | |
| "FareType": | |
| title: "FareType" | |
| type: string | |
| enum: | |
| - "regular" | |
| - "student" | |
| - "senior" | |
| - "tram" | |
| - "special" | |
| - "youth" | |
| "FeedScopedId": | |
| title: "FeedScopedId" | |
| type: object | |
| properties: | |
| "agencyId": | |
| type: string | |
| "id": | |
| type: string | |
| example: | |
| agencyId: "..." | |
| id: "..." | |
| "GeocoderResult": | |
| title: "GeocoderResult" | |
| type: object | |
| required: | |
| - "lat" | |
| - "lng" | |
| properties: | |
| "lat": | |
| type: number | |
| format: double | |
| "lng": | |
| type: number | |
| format: double | |
| "description": | |
| type: string | |
| example: | |
| lat: 12345.0 | |
| lng: 12345.0 | |
| description: "..." | |
| "GeocoderResults": | |
| title: "GeocoderResults" | |
| type: object | |
| required: | |
| - "count" | |
| properties: | |
| "error": | |
| type: string | |
| "results": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/GeocoderResult" | |
| "count": | |
| type: integer | |
| format: int32 | |
| example: | |
| error: "..." | |
| results: | |
| - lat: 12345.0 | |
| lng: 12345.0 | |
| description: "..." | |
| - lat: 12345.0 | |
| lng: 12345.0 | |
| description: "..." | |
| count: 12345 | |
| "Geometry": | |
| oneOf: | |
| - $ref: "#/components/schemas/Point" | |
| "GeometryFactory": | |
| title: "GeometryFactory" | |
| type: object | |
| required: | |
| - "SRID" | |
| properties: | |
| "precisionModel": | |
| $ref: "#/components/schemas/PrecisionModel" | |
| "SRID": | |
| type: integer | |
| format: int32 | |
| "coordinateSequenceFactory": | |
| $ref: "#/components/schemas/CoordinateSequenceFactory" | |
| example: | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| SRID: 12345 | |
| coordinateSequenceFactory: {} | |
| "I18NString": | |
| oneOf: | |
| - $ref: "#/components/schemas/NonLocalizedString" | |
| - $ref: "#/components/schemas/TranslatedString" | |
| - $ref: "#/components/schemas/LocalizedString" | |
| "InspectorLayer": | |
| title: "InspectorLayer" | |
| type: object | |
| example: | |
| "InspectorLayersList": | |
| title: "InspectorLayersList" | |
| type: object | |
| properties: | |
| "layers": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/InspectorLayer" | |
| example: | |
| layers: | |
| - {} | |
| - {} | |
| "Itinerary": | |
| title: "Itinerary" | |
| type: object | |
| required: | |
| - "walkTime" | |
| - "transitTime" | |
| - "waitingTime" | |
| - "walkLimitExceeded" | |
| - "tooSloped" | |
| properties: | |
| "duration": | |
| description: "Duration of the trip on this itinerary, in seconds." | |
| type: integer | |
| format: int64 | |
| "startTime": | |
| description: "Time that the trip departs." | |
| type: integer | |
| format: int32 | |
| "endTime": | |
| description: "Time that the trip arrives." | |
| type: integer | |
| format: int32 | |
| "walkTime": | |
| description: "How much time is spent walking, in seconds." | |
| type: integer | |
| format: int64 | |
| "transitTime": | |
| description: "How much time is spent on transit, in seconds." | |
| type: integer | |
| format: int64 | |
| "waitingTime": | |
| description: "How much time is spent waiting for transit to arrive, in seconds." | |
| type: integer | |
| format: int64 | |
| "walkDistance": | |
| description: "How far the user has to walk, in meters." | |
| type: number | |
| "walkLimitExceeded": | |
| description: "Indicates that the walk limit distance has been exceeded for this itinerary when true." | |
| type: boolean | |
| "elevationLost": | |
| description: "How much elevation is lost, in total, over the course of the trip, in meters. As an example,\na trip that went from the top of Mount Everest straight down to sea level, then back up K2,\nthen back down again would have an elevationLost of Everest + K2." | |
| type: number | |
| "elevationGained": | |
| description: "How much elevation is gained, in total, over the course of the trip, in meters. See\nelevationLost." | |
| type: number | |
| "transfers": | |
| description: "The number of transfers this trip has." | |
| type: integer | |
| format: int32 | |
| "fare": | |
| $ref: "#/components/schemas/Fare" | |
| "legs": | |
| description: "A list of Legs. Each Leg is either a walking (cycling, car) portion of the trip, or a transit\ntrip on a particular vehicle. So a trip where the use walks to the Q train, transfers to the\n6, then walks to their destination, has four legs." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Leg" | |
| "tooSloped": | |
| description: "This itinerary has a greater slope than the user requested (but there are no possible\nitineraries with a good slope)." | |
| type: boolean | |
| example: | |
| duration: 12345 | |
| startTime: 12345 | |
| endTime: 12345 | |
| walkTime: 12345 | |
| transitTime: 12345 | |
| waitingTime: 12345 | |
| walkDistance: 12345.0 | |
| walkLimitExceeded: true | |
| elevationLost: 12345.0 | |
| elevationGained: 12345.0 | |
| transfers: 12345 | |
| fare: | |
| fare: | |
| property1: | |
| currency: {} | |
| cents: 12345 | |
| property2: | |
| currency: {} | |
| cents: 12345 | |
| details: | |
| property1: | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| property2: | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| legs: | |
| - startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: | |
| agencyId: "..." | |
| id: "..." | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: | |
| agencyId: "..." | |
| id: "..." | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| boardAlightType: "DEVIATED" | |
| flagStopArea: {} | |
| to: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: {} | |
| intermediateStops: | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: {} | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: {} | |
| legGeometry: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| steps: | |
| - distance: 12345.0 | |
| relativeDirection: "DEPART" | |
| streetName: "..." | |
| absoluteDirection: "NORTHEAST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| - distance: 12345.0 | |
| relativeDirection: "UTURN_LEFT" | |
| streetName: "..." | |
| absoluteDirection: "SOUTHWEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| - startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: | |
| agencyId: "..." | |
| id: "..." | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: | |
| agencyId: "..." | |
| id: "..." | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "TRANSIT" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: {} | |
| to: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: {} | |
| intermediateStops: | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: {} | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: {} | |
| legGeometry: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| steps: | |
| - distance: 12345.0 | |
| relativeDirection: "HARD_RIGHT" | |
| streetName: "..." | |
| absoluteDirection: "NORTH" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| - distance: 12345.0 | |
| relativeDirection: "UTURN_RIGHT" | |
| streetName: "..." | |
| absoluteDirection: "SOUTHWEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| tooSloped: true | |
| "Leg": | |
| title: "Leg" | |
| type: object | |
| required: | |
| - "departureDelay" | |
| - "arrivalDelay" | |
| - "agencyTimeZoneOffset" | |
| - "flexDrtAdvanceBookMin" | |
| - "duration" | |
| properties: | |
| "startTime": | |
| description: "The date and time this leg begins." | |
| type: integer | |
| format: int32 | |
| "endTime": | |
| description: "The date and time this leg ends." | |
| type: integer | |
| format: int32 | |
| "departureDelay": | |
| description: "For transit leg, the offset from the scheduled departure-time of the boarding stop in this leg.\n\"scheduled time of departure at boarding stop\" = startTime - departureDelay" | |
| type: integer | |
| format: int32 | |
| "arrivalDelay": | |
| description: "For transit leg, the offset from the scheduled arrival-time of the alighting stop in this leg.\n\"scheduled time of arrival at alighting stop\" = endTime - arrivalDelay" | |
| type: integer | |
| format: int32 | |
| "realTime": | |
| description: "Whether there is real-time data about this Leg" | |
| type: boolean | |
| "isNonExactFrequency": | |
| description: "Is this a frequency-based trip with non-strict departure times?" | |
| type: boolean | |
| "headway": | |
| description: "The best estimate of the time between two arriving vehicles. This is particularly important\nfor non-strict frequency trips, but could become important for real-time trips, strict\nfrequency trips, and scheduled trips with empirical headways." | |
| type: integer | |
| format: int32 | |
| "distance": | |
| description: "The distance traveled while traversing the leg in meters." | |
| type: number | |
| "pathway": | |
| description: "Is this leg a traversing pathways?" | |
| type: boolean | |
| "mode": | |
| description: "The mode (e.g., <code>Walk</code>) used when traversing this leg." | |
| type: string | |
| "route": | |
| description: "For transit legs, the route of the bus or train being used. For non-transit legs, the name of\nthe street being traversed." | |
| type: string | |
| "agencyName": | |
| type: string | |
| "agencyUrl": | |
| type: string | |
| "agencyBrandingUrl": | |
| type: string | |
| "agencyTimeZoneOffset": | |
| type: integer | |
| format: int32 | |
| "routeColor": | |
| description: "For transit leg, the route's (background) color (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeType": | |
| description: "For transit legs, the type of the route. Non transit -1\nWhen 0-7: 0 Tram, 1 Subway, 2 Train, 3 Bus, 4 Ferry, 5 Cable Car, 6 Gondola, 7 Funicular\nWhen equal or highter than 100, it is coded using the Hierarchical Vehicle Type (HVT) codes from the European TPEG standard\nAlso see http://groups.google.com/group/gtfs-changes/msg/ed917a69cf8c5bef" | |
| type: integer | |
| format: int32 | |
| "routeId": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "routeTextColor": | |
| description: "For transit leg, the route's text color (if one exists). For non-transit legs, null." | |
| type: string | |
| "interlineWithPreviousLeg": | |
| description: "For transit legs, if the rider should stay on the vehicle as it changes route names." | |
| type: boolean | |
| "tripShortName": | |
| description: "For transit leg, the trip's short name (if one exists). For non-transit legs, null." | |
| type: string | |
| "tripBlockId": | |
| description: "For transit leg, the trip's block ID (if one exists). For non-transit legs, null." | |
| type: string | |
| "headsign": | |
| description: "For transit legs, the headsign of the bus or train being used. For non-transit legs, null." | |
| type: string | |
| "agencyId": | |
| description: "For transit legs, the ID of the transit agency that operates the service used for this leg.\nFor non-transit legs, null." | |
| type: string | |
| "tripId": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "serviceDate": | |
| description: "For transit legs, the service date of the trip.\nFor non-transit legs, null." | |
| type: string | |
| "routeBrandingUrl": | |
| description: "For transit leg, the route's branding URL (if one exists). For non-transit legs, null." | |
| type: string | |
| "from": | |
| $ref: "#/components/schemas/Place" | |
| "to": | |
| $ref: "#/components/schemas/Place" | |
| "intermediateStops": | |
| description: "For transit legs, intermediate stops between the Place where the leg originates and the Place where the leg ends.\nFor non-transit legs, null.\nThis field is optional i.e. it is always null unless \"showIntermediateStops\" parameter is set to \"true\" in the planner request." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Place" | |
| "legGeometry": | |
| $ref: "#/components/schemas/EncodedPolylineBean" | |
| "steps": | |
| description: "A series of turn by turn instructions used for walking, biking and driving." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/WalkStep" | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/LocalizedAlert" | |
| "routeShortName": | |
| type: string | |
| "routeLongName": | |
| type: string | |
| "boardRule": | |
| type: string | |
| "alightRule": | |
| type: string | |
| "rentedBike": | |
| type: boolean | |
| "callAndRide": | |
| description: "True if this is a call-and-ride leg." | |
| type: boolean | |
| "flexCallAndRideMaxStartTime": | |
| type: integer | |
| format: int32 | |
| "flexCallAndRideMinEndTime": | |
| type: integer | |
| format: int32 | |
| "flexDrtAdvanceBookMin": | |
| description: "trip.drt_advance_book_min if this is a demand-response leg" | |
| type: number | |
| format: double | |
| "flexDrtPickupMessage": | |
| description: "Agency message if this is leg has a demand-response pickup and the Trip has\n`drt_pickup_message` defined." | |
| type: string | |
| "flexDrtDropOffMessage": | |
| description: "Agency message if this is leg has a demand-response dropoff and the Trip has\n`drt_drop_off_message` defined." | |
| type: string | |
| "flexFlagStopPickupMessage": | |
| description: "Agency message if this is leg has a flag stop pickup and the Trip has\n`continuous_pickup_message` defined." | |
| type: string | |
| "flexFlagStopDropOffMessage": | |
| description: "Agency message if this is leg has a flag stop dropoff and the Trip has\n`continuous_drop_off_message` defined." | |
| type: string | |
| "transitLeg": | |
| description: "Whether this leg is a transit leg or not." | |
| type: boolean | |
| "duration": | |
| description: "The leg's duration in seconds" | |
| type: number | |
| format: double | |
| example: | |
| startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: | |
| agencyId: "..." | |
| id: "..." | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: | |
| agencyId: "..." | |
| id: "..." | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: | |
| name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| to: | |
| name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKESHARE" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| intermediateStops: | |
| - name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| - name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| legGeometry: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| steps: | |
| - distance: 12345.0 | |
| relativeDirection: "DEPART" | |
| streetName: "..." | |
| absoluteDirection: "SOUTHEAST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - first: {} | |
| second: {} | |
| - first: {} | |
| second: {} | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - distance: 12345.0 | |
| relativeDirection: "HARD_RIGHT" | |
| streetName: "..." | |
| absoluteDirection: "NORTHWEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - first: {} | |
| second: {} | |
| - first: {} | |
| second: {} | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| "LocalizedAlert": | |
| title: "LocalizedAlert" | |
| type: object | |
| properties: | |
| "alertHeaderText": | |
| type: string | |
| "alertDescriptionText": | |
| type: string | |
| "alertUrl": | |
| type: string | |
| "effectiveStartDate": | |
| type: integer | |
| format: int32 | |
| example: | |
| alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| "LocalizedString": | |
| title: "LocalizedString" | |
| type: object | |
| example: | |
| "MavenVersion": | |
| title: "MavenVersion" | |
| type: object | |
| required: | |
| - "major" | |
| - "minor" | |
| - "incremental" | |
| - "UID" | |
| properties: | |
| "version": | |
| type: string | |
| "major": | |
| type: integer | |
| format: int32 | |
| "minor": | |
| type: integer | |
| format: int32 | |
| "incremental": | |
| type: integer | |
| format: int32 | |
| "qualifier": | |
| type: string | |
| "commit": | |
| type: string | |
| "describe": | |
| type: string | |
| "commit_time": | |
| type: string | |
| "build_time": | |
| type: string | |
| "UID": | |
| type: integer | |
| format: int64 | |
| "shortVersionString": | |
| type: string | |
| "longVersionString": | |
| type: string | |
| example: | |
| version: "..." | |
| major: 12345 | |
| minor: 12345 | |
| incremental: 12345 | |
| qualifier: "..." | |
| commit: "..." | |
| describe: "..." | |
| commit_time: "..." | |
| build_time: "..." | |
| UID: 12345 | |
| shortVersionString: "..." | |
| longVersionString: "..." | |
| "Message": | |
| title: "Message" | |
| type: string | |
| enum: | |
| - "PLAN_OK" | |
| - "SYSTEM_ERROR" | |
| - "GRAPH_UNAVAILABLE" | |
| - "OUTSIDE_BOUNDS" | |
| - "PATH_NOT_FOUND" | |
| - "NO_TRANSIT_TIMES" | |
| - "REQUEST_TIMEOUT" | |
| - "BOGUS_PARAMETER" | |
| - "GEOCODE_FROM_NOT_FOUND" | |
| - "GEOCODE_TO_NOT_FOUND" | |
| - "GEOCODE_FROM_TO_NOT_FOUND" | |
| - "TOO_CLOSE" | |
| - "LOCATION_NOT_ACCESSIBLE" | |
| - "GEOCODE_FROM_AMBIGUOUS" | |
| - "GEOCODE_TO_AMBIGUOUS" | |
| - "GEOCODE_FROM_TO_AMBIGUOUS" | |
| - "UNDERSPECIFIED_TRIANGLE" | |
| - "TRIANGLE_NOT_AFFINE" | |
| - "TRIANGLE_OPTIMIZE_TYPE_NOT_SET" | |
| - "TRIANGLE_VALUES_NOT_SET" | |
| "Money": | |
| title: "Money" | |
| type: object | |
| required: | |
| - "cents" | |
| properties: | |
| "currency": | |
| $ref: "#/components/schemas/WrappedCurrency" | |
| "cents": | |
| type: integer | |
| format: int32 | |
| example: | |
| currency: | |
| defaultFractionDigits: 12345 | |
| currencyCode: "..." | |
| symbol: "..." | |
| currency: "..." | |
| cents: 12345 | |
| "NonLocalizedString": | |
| title: "NonLocalizedString" | |
| type: object | |
| example: | |
| "P2": | |
| title: "P2" | |
| allOf: | |
| - $ref: "#/components/schemas/T2" | |
| - type: object | |
| example: | |
| first: {} | |
| second: {} | |
| "P2OfDouble": | |
| title: "P2OfDouble" | |
| allOf: | |
| - $ref: "#/components/schemas/T2" | |
| - type: object | |
| example: | |
| first: {} | |
| second: {} | |
| "PackedCoordinateSequence": | |
| title: "PackedCoordinateSequence" | |
| type: object | |
| required: | |
| - "dimension" | |
| properties: | |
| "dimension": | |
| type: integer | |
| format: int32 | |
| example: | |
| dimension: 12345 | |
| "Place": | |
| title: "Place" | |
| type: object | |
| properties: | |
| "name": | |
| description: "For transit stops, the name of the stop. For points of interest, the name of the POI." | |
| type: string | |
| "stopId": | |
| $ref: "#/components/schemas/FeedScopedId" | |
| "stopCode": | |
| description: "The \"code\" of the stop. Depending on the transit agency, this is often\nsomething that users care about." | |
| type: string | |
| "platformCode": | |
| description: "The code or name identifying the quay/platform the vehicle will arrive at or depart from" | |
| type: string | |
| "lon": | |
| description: "The longitude of the place." | |
| type: number | |
| "lat": | |
| description: "The latitude of the place." | |
| type: number | |
| "arrival": | |
| description: "The time the rider will arrive at the place." | |
| type: integer | |
| format: int32 | |
| "departure": | |
| description: "The time the rider will depart the place." | |
| type: integer | |
| format: int32 | |
| "orig": | |
| type: string | |
| "zoneId": | |
| type: string | |
| "stopIndex": | |
| description: "For transit trips, the stop index (numbered from zero from the start of the trip" | |
| type: integer | |
| format: int32 | |
| "stopSequence": | |
| description: "For transit trips, the sequence number of the stop. Per GTFS, these numbers are increasing." | |
| type: integer | |
| format: int32 | |
| "vertexType": | |
| $ref: "#/components/schemas/VertexType" | |
| "bikeShareId": | |
| description: "In case the vertex is of type Bike sharing station." | |
| type: string | |
| "boardAlightType": | |
| $ref: "#/components/schemas/BoardAlightType" | |
| "flagStopArea": | |
| $ref: "#/components/schemas/EncodedPolylineBean" | |
| example: | |
| name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| boardAlightType: "DEVIATED" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| "PlannerError": | |
| title: "PlannerError" | |
| type: object | |
| required: | |
| - "id" | |
| - "noPath" | |
| properties: | |
| "id": | |
| type: integer | |
| format: int32 | |
| "msg": | |
| type: string | |
| "message": | |
| $ref: "#/components/schemas/Message" | |
| "missing": | |
| description: "the list of point names which cannot be found (from, to, intermediate.n)" | |
| type: array | |
| items: | |
| type: string | |
| "noPath": | |
| description: "whether no path has been found" | |
| type: boolean | |
| example: | |
| id: 12345 | |
| msg: "..." | |
| message: "GEOCODE_FROM_TO_AMBIGUOUS" | |
| missing: | |
| - "..." | |
| - "..." | |
| noPath: true | |
| "Point": | |
| title: "Point" | |
| allOf: | |
| - $ref: "#/components/schemas/Geometry" | |
| - type: object | |
| required: | |
| - "simple" | |
| - "y" | |
| - "empty" | |
| - "dimension" | |
| - "boundaryDimension" | |
| - "numPoints" | |
| - "x" | |
| properties: | |
| "simple": | |
| type: boolean | |
| "y": | |
| type: number | |
| format: double | |
| "empty": | |
| type: boolean | |
| "dimension": | |
| type: integer | |
| format: int32 | |
| "boundary": | |
| $ref: "#/components/schemas/Geometry" | |
| "geometryType": | |
| type: string | |
| "boundaryDimension": | |
| type: integer | |
| format: int32 | |
| "numPoints": | |
| type: integer | |
| format: int32 | |
| "coordinates": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Coordinate" | |
| "coordinate": | |
| $ref: "#/components/schemas/Coordinate" | |
| "x": | |
| type: number | |
| format: double | |
| "coordinateSequence": | |
| $ref: "#/components/schemas/CoordinateSequence" | |
| example: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: | |
| coordinates: | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| envelopeInternal: | |
| maxX: 12345.0 | |
| null: true | |
| area: 12345.0 | |
| maxY: 12345.0 | |
| height: 12345.0 | |
| width: 12345.0 | |
| minX: 12345.0 | |
| minY: 12345.0 | |
| factory: | |
| precisionModel: {} | |
| SRID: 12345 | |
| coordinateSequenceFactory: {} | |
| length: 12345.0 | |
| valid: true | |
| geometryType: "..." | |
| userData: {} | |
| simple: true | |
| rectangle: true | |
| numPoints: 12345 | |
| boundary: {} | |
| coordinate: | |
| m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| boundaryDimension: 12345 | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - {} | |
| - {} | |
| coordinate: {} | |
| x: 12345.0 | |
| coordinateSequence: {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| numGeometries: 12345 | |
| centroid: {} | |
| envelope: {} | |
| dimension: 12345 | |
| numGeometries: 12345 | |
| empty: true | |
| centroid: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - {} | |
| - {} | |
| coordinate: {} | |
| x: 12345.0 | |
| coordinateSequence: {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| numGeometries: 12345 | |
| centroid: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| coordinate: | |
| m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| x: 12345.0 | |
| coordinateSequence: | |
| measures: 12345 | |
| dimension: 12345 | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| envelopeInternal: | |
| maxX: 12345.0 | |
| null: true | |
| area: 12345.0 | |
| maxY: 12345.0 | |
| height: 12345.0 | |
| width: 12345.0 | |
| minX: 12345.0 | |
| minY: 12345.0 | |
| factory: | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| SRID: 12345 | |
| coordinateSequenceFactory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: | |
| coordinates: | |
| - {} | |
| - {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| geometryType: "..." | |
| userData: {} | |
| simple: true | |
| rectangle: true | |
| numPoints: 12345 | |
| boundary: {} | |
| coordinate: {} | |
| boundaryDimension: 12345 | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| dimension: 12345 | |
| numGeometries: 12345 | |
| empty: true | |
| centroid: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| coordinate: | |
| m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| x: 12345.0 | |
| coordinateSequence: | |
| measures: 12345 | |
| dimension: 12345 | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| envelopeInternal: | |
| maxX: 12345.0 | |
| null: true | |
| area: 12345.0 | |
| maxY: 12345.0 | |
| height: 12345.0 | |
| width: 12345.0 | |
| minX: 12345.0 | |
| minY: 12345.0 | |
| factory: | |
| precisionModel: {} | |
| SRID: 12345 | |
| coordinateSequenceFactory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: | |
| coordinates: | |
| - {} | |
| - {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| geometryType: "..." | |
| userData: {} | |
| simple: true | |
| rectangle: true | |
| numPoints: 12345 | |
| boundary: {} | |
| coordinate: {} | |
| boundaryDimension: 12345 | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| dimension: 12345 | |
| numGeometries: 12345 | |
| empty: true | |
| centroid: {} | |
| numGeometries: 12345 | |
| centroid: {} | |
| envelope: | |
| coordinates: | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| envelopeInternal: | |
| maxX: 12345.0 | |
| null: true | |
| area: 12345.0 | |
| maxY: 12345.0 | |
| height: 12345.0 | |
| width: 12345.0 | |
| minX: 12345.0 | |
| minY: 12345.0 | |
| factory: | |
| precisionModel: {} | |
| SRID: 12345 | |
| coordinateSequenceFactory: {} | |
| length: 12345.0 | |
| valid: true | |
| geometryType: "..." | |
| userData: {} | |
| simple: true | |
| rectangle: true | |
| numPoints: 12345 | |
| boundary: {} | |
| coordinate: | |
| m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| boundaryDimension: 12345 | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - {} | |
| - {} | |
| coordinate: {} | |
| x: 12345.0 | |
| coordinateSequence: {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| numGeometries: 12345 | |
| centroid: {} | |
| envelope: {} | |
| dimension: 12345 | |
| numGeometries: 12345 | |
| empty: true | |
| centroid: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - {} | |
| - {} | |
| coordinate: {} | |
| x: 12345.0 | |
| coordinateSequence: {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| numGeometries: 12345 | |
| centroid: {} | |
| numGeometries: 12345 | |
| centroid: | |
| simple: true | |
| y: 12345.0 | |
| empty: true | |
| dimension: 12345 | |
| boundary: | |
| coordinates: | |
| - {} | |
| - {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| geometryType: "..." | |
| userData: {} | |
| simple: true | |
| rectangle: true | |
| numPoints: 12345 | |
| boundary: {} | |
| coordinate: {} | |
| boundaryDimension: 12345 | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| dimension: 12345 | |
| numGeometries: 12345 | |
| empty: true | |
| centroid: {} | |
| geometryType: "..." | |
| boundaryDimension: 12345 | |
| numPoints: 12345 | |
| coordinates: | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| - m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| coordinate: | |
| m: 12345.0 | |
| x: 12345.0 | |
| y: 12345.0 | |
| z: 12345.0 | |
| x: 12345.0 | |
| coordinateSequence: | |
| measures: 12345 | |
| dimension: 12345 | |
| precisionModel: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| envelopeInternal: | |
| maxX: 12345.0 | |
| null: true | |
| area: 12345.0 | |
| maxY: 12345.0 | |
| height: 12345.0 | |
| width: 12345.0 | |
| minX: 12345.0 | |
| minY: 12345.0 | |
| factory: | |
| precisionModel: {} | |
| SRID: 12345 | |
| coordinateSequenceFactory: {} | |
| length: 12345.0 | |
| valid: true | |
| userData: {} | |
| rectangle: true | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: | |
| coordinates: | |
| - {} | |
| - {} | |
| precisionModel: {} | |
| envelopeInternal: {} | |
| factory: {} | |
| length: 12345.0 | |
| valid: true | |
| geometryType: "..." | |
| userData: {} | |
| simple: true | |
| rectangle: true | |
| numPoints: 12345 | |
| boundary: {} | |
| coordinate: {} | |
| boundaryDimension: 12345 | |
| SRID: 12345 | |
| area: 12345.0 | |
| interiorPoint: {} | |
| envelope: {} | |
| dimension: 12345 | |
| numGeometries: 12345 | |
| empty: true | |
| centroid: {} | |
| numGeometries: 12345 | |
| centroid: {} | |
| "PrecisionModel": | |
| title: "PrecisionModel" | |
| type: object | |
| required: | |
| - "scale" | |
| - "offsetX" | |
| - "offsetY" | |
| - "maximumSignificantDigits" | |
| - "floating" | |
| properties: | |
| "scale": | |
| type: number | |
| format: double | |
| "offsetX": | |
| type: number | |
| format: double | |
| "offsetY": | |
| type: number | |
| format: double | |
| "maximumSignificantDigits": | |
| type: integer | |
| format: int32 | |
| "floating": | |
| type: boolean | |
| "type": | |
| $ref: "#/components/schemas/Type" | |
| example: | |
| scale: 12345.0 | |
| offsetX: 12345.0 | |
| offsetY: 12345.0 | |
| maximumSignificantDigits: 12345 | |
| floating: true | |
| type: {} | |
| "RelativeDirection": | |
| title: "RelativeDirection" | |
| type: string | |
| enum: | |
| - "DEPART" | |
| - "HARD_LEFT" | |
| - "LEFT" | |
| - "SLIGHTLY_LEFT" | |
| - "CONTINUE" | |
| - "SLIGHTLY_RIGHT" | |
| - "RIGHT" | |
| - "HARD_RIGHT" | |
| - "CIRCLE_CLOCKWISE" | |
| - "CIRCLE_COUNTERCLOCKWISE" | |
| - "ELEVATOR" | |
| - "UTURN_LEFT" | |
| - "UTURN_RIGHT" | |
| "Response": | |
| title: "Response" | |
| type: object | |
| properties: | |
| "requestParameters": | |
| description: "A dictionary of the parameters provided in the request that triggered this response." | |
| type: object | |
| additionalProperties: | |
| type: string | |
| "debugOutput": | |
| $ref: "#/components/schemas/DebugOutput" | |
| "elevationMetadata": | |
| $ref: "#/components/schemas/ElevationMetadata" | |
| "plan": | |
| $ref: "#/components/schemas/TripPlan" | |
| "error": | |
| $ref: "#/components/schemas/PlannerError" | |
| example: | |
| requestParameters: | |
| property1: "..." | |
| property2: "..." | |
| debugOutput: | |
| precalculationTime: 12345 | |
| pathCalculationTime: 12345 | |
| pathTimes: | |
| - 12345 | |
| - 12345 | |
| renderingTime: 12345 | |
| totalTime: 12345 | |
| timedOut: true | |
| elevationMetadata: | |
| ellipsoidToGeoidDifference: 12345.0 | |
| geoidElevation: true | |
| plan: | |
| date: 12345 | |
| from: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: {} | |
| to: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKESHARE" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: {} | |
| itineraries: | |
| - duration: 12345 | |
| startTime: 12345 | |
| endTime: 12345 | |
| walkTime: 12345 | |
| transitTime: 12345 | |
| waitingTime: 12345 | |
| walkDistance: 12345.0 | |
| walkLimitExceeded: true | |
| elevationLost: 12345.0 | |
| elevationGained: 12345.0 | |
| transfers: 12345 | |
| fare: {} | |
| legs: | |
| - {} | |
| - {} | |
| tooSloped: true | |
| - duration: 12345 | |
| startTime: 12345 | |
| endTime: 12345 | |
| walkTime: 12345 | |
| transitTime: 12345 | |
| waitingTime: 12345 | |
| walkDistance: 12345.0 | |
| walkLimitExceeded: true | |
| elevationLost: 12345.0 | |
| elevationGained: 12345.0 | |
| transfers: 12345 | |
| fare: {} | |
| legs: | |
| - {} | |
| - {} | |
| tooSloped: true | |
| error: | |
| id: 12345 | |
| msg: "..." | |
| message: "GEOCODE_FROM_AMBIGUOUS" | |
| missing: | |
| - "..." | |
| - "..." | |
| noPath: true | |
| "RouterInfo": | |
| title: "RouterInfo" | |
| type: object | |
| required: | |
| - "transitServiceStarts" | |
| - "transitServiceEnds" | |
| - "centerLatitude" | |
| - "centerLongitude" | |
| - "hasParkRide" | |
| - "hasBikeSharing" | |
| - "hasBikePark" | |
| - "lowerLeftLatitude" | |
| - "lowerLeftLongitude" | |
| - "upperRightLatitude" | |
| - "upperRightLongitude" | |
| properties: | |
| "routerId": | |
| type: string | |
| "polygon": | |
| type: string | |
| format: binary | |
| "buildTime": | |
| type: integer | |
| format: int32 | |
| "transitServiceStarts": | |
| type: integer | |
| format: int64 | |
| "transitServiceEnds": | |
| type: integer | |
| format: int64 | |
| "transitModes": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/TraverseMode" | |
| "centerLatitude": | |
| type: number | |
| format: double | |
| "centerLongitude": | |
| type: number | |
| format: double | |
| "hasParkRide": | |
| type: boolean | |
| "travelOptions": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/TravelOption" | |
| "hasBikeSharing": | |
| type: boolean | |
| "hasBikePark": | |
| type: boolean | |
| "lowerLeftLatitude": | |
| type: number | |
| format: double | |
| "lowerLeftLongitude": | |
| type: number | |
| format: double | |
| "upperRightLatitude": | |
| type: number | |
| format: double | |
| "upperRightLongitude": | |
| type: number | |
| format: double | |
| example: | |
| routerId: "..." | |
| polygon: {} | |
| buildTime: 12345 | |
| transitServiceStarts: 12345 | |
| transitServiceEnds: 12345 | |
| transitModes: | |
| - "GONDOLA" | |
| - "GONDOLA" | |
| centerLatitude: 12345.0 | |
| centerLongitude: 12345.0 | |
| hasParkRide: true | |
| travelOptions: | |
| - value: "..." | |
| name: "..." | |
| - value: "..." | |
| name: "..." | |
| hasBikeSharing: true | |
| hasBikePark: true | |
| lowerLeftLatitude: 12345.0 | |
| lowerLeftLongitude: 12345.0 | |
| upperRightLatitude: 12345.0 | |
| upperRightLongitude: 12345.0 | |
| "RouterList": | |
| title: "RouterList" | |
| type: object | |
| properties: | |
| "routerInfo": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/RouterInfo" | |
| example: | |
| routerInfo: | |
| - routerId: "..." | |
| polygon: {} | |
| buildTime: 12345 | |
| transitServiceStarts: 12345 | |
| transitServiceEnds: 12345 | |
| transitModes: | |
| - "AIRPLANE" | |
| - "WALK" | |
| centerLatitude: 12345.0 | |
| centerLongitude: 12345.0 | |
| hasParkRide: true | |
| travelOptions: | |
| - value: "..." | |
| name: "..." | |
| - value: "..." | |
| name: "..." | |
| hasBikeSharing: true | |
| hasBikePark: true | |
| lowerLeftLatitude: 12345.0 | |
| lowerLeftLongitude: 12345.0 | |
| upperRightLatitude: 12345.0 | |
| upperRightLongitude: 12345.0 | |
| - routerId: "..." | |
| polygon: {} | |
| buildTime: 12345 | |
| transitServiceStarts: 12345 | |
| transitServiceEnds: 12345 | |
| transitModes: | |
| - "TRANSIT" | |
| - "FERRY" | |
| centerLatitude: 12345.0 | |
| centerLongitude: 12345.0 | |
| hasParkRide: true | |
| travelOptions: | |
| - value: "..." | |
| name: "..." | |
| - value: "..." | |
| name: "..." | |
| hasBikeSharing: true | |
| hasBikePark: true | |
| lowerLeftLatitude: 12345.0 | |
| lowerLeftLongitude: 12345.0 | |
| upperRightLatitude: 12345.0 | |
| upperRightLongitude: 12345.0 | |
| "Serializable2DPackedCoordinateSequenceFactory": | |
| title: "Serializable2DPackedCoordinateSequenceFactory" | |
| type: object | |
| example: | |
| "ServerInfo": | |
| title: "ServerInfo" | |
| type: object | |
| required: | |
| - "nCores" | |
| properties: | |
| "serverInfo": | |
| $ref: "#/components/schemas/ServerInfo" | |
| "serverVersion": | |
| $ref: "#/components/schemas/MavenVersion" | |
| "cpuName": | |
| type: string | |
| "nCores": | |
| type: integer | |
| format: int32 | |
| example: | |
| serverInfo: | |
| serverInfo: {} | |
| serverVersion: | |
| version: "..." | |
| major: 12345 | |
| minor: 12345 | |
| incremental: 12345 | |
| qualifier: "..." | |
| commit: "..." | |
| describe: "..." | |
| commit_time: "..." | |
| build_time: "..." | |
| UID: 12345 | |
| shortVersionString: "..." | |
| longVersionString: "..." | |
| cpuName: "..." | |
| nCores: 12345 | |
| serverVersion: | |
| version: "..." | |
| major: 12345 | |
| minor: 12345 | |
| incremental: 12345 | |
| qualifier: "..." | |
| commit: "..." | |
| describe: "..." | |
| commit_time: "..." | |
| build_time: "..." | |
| UID: 12345 | |
| shortVersionString: "..." | |
| longVersionString: "..." | |
| cpuName: "..." | |
| nCores: 12345 | |
| "T2": | |
| title: "T2" | |
| type: object | |
| properties: | |
| "first": | |
| type: string | |
| format: binary | |
| "second": | |
| type: string | |
| format: binary | |
| example: | |
| first: {} | |
| second: {} | |
| "TranslatedString": | |
| title: "TranslatedString" | |
| type: object | |
| properties: | |
| "languages": | |
| description: "The available languages" | |
| type: array | |
| items: | |
| type: string | |
| "translations": | |
| description: "The available translations" | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/EntryOfStringAndString" | |
| example: | |
| languages: | |
| - "..." | |
| - "..." | |
| translations: | |
| - value: "..." | |
| key: "..." | |
| - value: "..." | |
| key: "..." | |
| "TravelOption": | |
| title: "TravelOption" | |
| type: object | |
| properties: | |
| "value": | |
| type: string | |
| "name": | |
| type: string | |
| example: | |
| value: "..." | |
| name: "..." | |
| "TraverseMode": | |
| title: "TraverseMode" | |
| type: string | |
| enum: | |
| - "WALK" | |
| - "BICYCLE" | |
| - "CAR" | |
| - "TRAM" | |
| - "SUBWAY" | |
| - "RAIL" | |
| - "BUS" | |
| - "FERRY" | |
| - "CABLE_CAR" | |
| - "GONDOLA" | |
| - "FUNICULAR" | |
| - "TRANSIT" | |
| - "LEG_SWITCH" | |
| - "AIRPLANE" | |
| "TripPlan": | |
| title: "TripPlan" | |
| type: object | |
| properties: | |
| "date": | |
| description: "The time and date of travel" | |
| type: integer | |
| format: int32 | |
| "from": | |
| $ref: "#/components/schemas/Place" | |
| "to": | |
| $ref: "#/components/schemas/Place" | |
| "itineraries": | |
| description: "A list of possible itineraries" | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Itinerary" | |
| example: | |
| date: 12345 | |
| from: | |
| name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKESHARE" | |
| bikeShareId: "..." | |
| boardAlightType: "FLAG_STOP" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| to: | |
| name: "..." | |
| stopId: | |
| agencyId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "TRANSIT" | |
| bikeShareId: "..." | |
| boardAlightType: "DEFAULT" | |
| flagStopArea: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| itineraries: | |
| - duration: 12345 | |
| startTime: 12345 | |
| endTime: 12345 | |
| walkTime: 12345 | |
| transitTime: 12345 | |
| waitingTime: 12345 | |
| walkDistance: 12345.0 | |
| walkLimitExceeded: true | |
| elevationLost: 12345.0 | |
| elevationGained: 12345.0 | |
| transfers: 12345 | |
| fare: | |
| fare: | |
| property1: {} | |
| property2: {} | |
| details: | |
| property1: | |
| - {} | |
| - {} | |
| property2: | |
| - {} | |
| - {} | |
| legs: | |
| - startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: {} | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: {} | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: {} | |
| to: {} | |
| intermediateStops: | |
| - {} | |
| - {} | |
| legGeometry: {} | |
| steps: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| - startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: {} | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: {} | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: {} | |
| to: {} | |
| intermediateStops: | |
| - {} | |
| - {} | |
| legGeometry: {} | |
| steps: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| tooSloped: true | |
| - duration: 12345 | |
| startTime: 12345 | |
| endTime: 12345 | |
| walkTime: 12345 | |
| transitTime: 12345 | |
| waitingTime: 12345 | |
| walkDistance: 12345.0 | |
| walkLimitExceeded: true | |
| elevationLost: 12345.0 | |
| elevationGained: 12345.0 | |
| transfers: 12345 | |
| fare: | |
| fare: | |
| property1: {} | |
| property2: {} | |
| details: | |
| property1: | |
| - {} | |
| - {} | |
| property2: | |
| - {} | |
| - {} | |
| legs: | |
| - startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: {} | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: {} | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: {} | |
| to: {} | |
| intermediateStops: | |
| - {} | |
| - {} | |
| legGeometry: {} | |
| steps: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| - startTime: 12345 | |
| endTime: 12345 | |
| departureDelay: 12345 | |
| arrivalDelay: 12345 | |
| realTime: true | |
| isNonExactFrequency: true | |
| headway: 12345 | |
| distance: 12345.0 | |
| pathway: true | |
| mode: "..." | |
| route: "..." | |
| agencyName: "..." | |
| agencyUrl: "..." | |
| agencyBrandingUrl: "..." | |
| agencyTimeZoneOffset: 12345 | |
| routeColor: "..." | |
| routeType: 12345 | |
| routeId: {} | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: {} | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: {} | |
| to: {} | |
| intermediateStops: | |
| - {} | |
| - {} | |
| legGeometry: {} | |
| steps: | |
| - {} | |
| - {} | |
| alerts: | |
| - {} | |
| - {} | |
| routeShortName: "..." | |
| routeLongName: "..." | |
| boardRule: "..." | |
| alightRule: "..." | |
| rentedBike: true | |
| callAndRide: true | |
| flexCallAndRideMaxStartTime: 12345 | |
| flexCallAndRideMinEndTime: 12345 | |
| flexDrtAdvanceBookMin: 12345.0 | |
| flexDrtPickupMessage: "..." | |
| flexDrtDropOffMessage: "..." | |
| flexFlagStopPickupMessage: "..." | |
| flexFlagStopDropOffMessage: "..." | |
| transitLeg: true | |
| duration: 12345.0 | |
| tooSloped: true | |
| "Type": | |
| title: "Type" | |
| type: object | |
| example: | |
| "VertexType": | |
| title: "VertexType" | |
| type: string | |
| enum: | |
| - "NORMAL" | |
| - "BIKESHARE" | |
| - "BIKEPARK" | |
| - "TRANSIT" | |
| "WalkStep": | |
| title: "WalkStep" | |
| type: object | |
| required: | |
| - "distance" | |
| - "lon" | |
| - "lat" | |
| properties: | |
| "distance": | |
| description: "The distance in meters that this step takes." | |
| type: number | |
| format: double | |
| "relativeDirection": | |
| $ref: "#/components/schemas/RelativeDirection" | |
| "streetName": | |
| description: "The name of the street." | |
| type: string | |
| "absoluteDirection": | |
| $ref: "#/components/schemas/AbsoluteDirection" | |
| "exit": | |
| description: "When exiting a highway or traffic circle, the exit name/number." | |
| type: string | |
| "stayOn": | |
| description: "Indicates whether or not a street changes direction at an intersection." | |
| type: boolean | |
| "area": | |
| description: "This step is on an open area, such as a plaza or train platform, and thus the directions should say something like \"cross\"" | |
| type: boolean | |
| "bogusName": | |
| description: "The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions" | |
| type: boolean | |
| "lon": | |
| description: "The longitude of start of the step" | |
| type: number | |
| format: double | |
| "lat": | |
| description: "The latitude of start of the step" | |
| type: number | |
| format: double | |
| "elevation": | |
| description: "The elevation profile as a comma-separated list of x,y values. x is the distance from the start of the step, y is the elevation at this\ndistance." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/P2OfDouble" | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/LocalizedAlert" | |
| example: | |
| distance: 12345.0 | |
| relativeDirection: "HARD_LEFT" | |
| streetName: "..." | |
| absoluteDirection: "SOUTH" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: | |
| - first: {} | |
| second: {} | |
| - first: {} | |
| second: {} | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| "WrappedCurrency": | |
| title: "WrappedCurrency" | |
| type: object | |
| required: | |
| - "defaultFractionDigits" | |
| properties: | |
| "defaultFractionDigits": | |
| type: integer | |
| format: int32 | |
| "currencyCode": | |
| type: string | |
| "symbol": | |
| type: string | |
| "currency": | |
| type: string | |
| example: | |
| defaultFractionDigits: 12345 | |
| currencyCode: "..." | |
| symbol: "..." | |
| currency: "..." | |
| "xml_ns0_locale": | |
| title: "locale" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "default": | |
| $ref: "#/components/schemas/xml_ns0_locale" | |
| "xml_ns0_geometry": | |
| title: "geometry" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "SRID" | |
| properties: | |
| "SRID": | |
| type: integer | |
| format: int32 | |
| "userData": | |
| type: string | |
| format: binary | |
| "xml_ns0_message": | |
| title: "message" | |
| type: string | |
| enum: | |
| - "PLAN_OK" | |
| - "SYSTEM_ERROR" | |
| - "GRAPH_UNAVAILABLE" | |
| - "OUTSIDE_BOUNDS" | |
| - "PATH_NOT_FOUND" | |
| - "NO_TRANSIT_TIMES" | |
| - "REQUEST_TIMEOUT" | |
| - "BOGUS_PARAMETER" | |
| - "GEOCODE_FROM_NOT_FOUND" | |
| - "GEOCODE_TO_NOT_FOUND" | |
| - "GEOCODE_FROM_TO_NOT_FOUND" | |
| - "TOO_CLOSE" | |
| - "LOCATION_NOT_ACCESSIBLE" | |
| - "GEOCODE_FROM_AMBIGUOUS" | |
| - "GEOCODE_TO_AMBIGUOUS" | |
| - "GEOCODE_FROM_TO_AMBIGUOUS" | |
| - "UNDERSPECIFIED_TRIANGLE" | |
| - "TRIANGLE_NOT_AFFINE" | |
| - "TRIANGLE_OPTIMIZE_TYPE_NOT_SET" | |
| - "TRIANGLE_VALUES_NOT_SET" | |
| "xml_ns0_absoluteDirection": | |
| title: "absoluteDirection" | |
| type: string | |
| enum: | |
| - "NORTH" | |
| - "NORTHEAST" | |
| - "EAST" | |
| - "SOUTHEAST" | |
| - "SOUTH" | |
| - "SOUTHWEST" | |
| - "WEST" | |
| - "NORTHWEST" | |
| "xml_ns0_boardAlightType": | |
| title: "boardAlightType" | |
| type: string | |
| enum: | |
| - "DEFAULT" | |
| - "FLAG_STOP" | |
| - "DEVIATED" | |
| "xml_ns0_itinerary": | |
| title: "itinerary" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "tooSloped" | |
| - "transitTime" | |
| - "waitingTime" | |
| - "walkLimitExceeded" | |
| - "walkTime" | |
| properties: | |
| "duration": | |
| description: "Duration of the trip on this itinerary, in seconds." | |
| type: integer | |
| format: int64 | |
| "elevationGained": | |
| description: "How much elevation is gained, in total, over the course of the trip, in meters. See\nelevationLost." | |
| type: number | |
| format: double | |
| "elevationLost": | |
| description: "How much elevation is lost, in total, over the course of the trip, in meters. As an example,\na trip that went from the top of Mount Everest straight down to sea level, then back up K2,\nthen back down again would have an elevationLost of Everest + K2." | |
| type: number | |
| format: double | |
| "endTime": | |
| description: "Time that the trip arrives." | |
| type: string | |
| format: date-time | |
| "fare": | |
| $ref: "#/components/schemas/xml_ns0_fare" | |
| "legs": | |
| description: "A list of Legs. Each Leg is either a walking (cycling, car) portion of the trip, or a transit\ntrip on a particular vehicle. So a trip where the use walks to the Q train, transfers to the\n6, then walks to their destination, has four legs." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_leg" | |
| "startTime": | |
| description: "Time that the trip departs." | |
| type: string | |
| format: date-time | |
| "tooSloped": | |
| description: "This itinerary has a greater slope than the user requested (but there are no possible\nitineraries with a good slope)." | |
| type: boolean | |
| "transfers": | |
| description: "The number of transfers this trip has." | |
| type: integer | |
| format: int32 | |
| "transitTime": | |
| description: "How much time is spent on transit, in seconds." | |
| type: integer | |
| format: int64 | |
| "waitingTime": | |
| description: "How much time is spent waiting for transit to arrive, in seconds." | |
| type: integer | |
| format: int64 | |
| "walkDistance": | |
| description: "How far the user has to walk, in meters." | |
| type: number | |
| format: double | |
| "walkLimitExceeded": | |
| description: "Indicates that the walk limit distance has been exceeded for this itinerary when true." | |
| type: boolean | |
| "walkTime": | |
| description: "How much time is spent walking, in seconds." | |
| type: integer | |
| format: int64 | |
| "xml_ns0_leg": | |
| title: "leg" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "agencyTimeZoneOffset" | |
| - "arrivalDelay" | |
| - "departureDelay" | |
| - "flexDrtAdvanceBookMin" | |
| properties: | |
| "agencyBrandingUrl": | |
| type: string | |
| "agencyId": | |
| description: "For transit legs, the ID of the transit agency that operates the service used for this leg.\nFor non-transit legs, null." | |
| type: string | |
| "agencyName": | |
| type: string | |
| "agencyTimeZoneOffset": | |
| type: integer | |
| format: int32 | |
| "agencyUrl": | |
| type: string | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_localizedAlert" | |
| "alightRule": | |
| type: string | |
| "arrivalDelay": | |
| description: "For transit leg, the offset from the scheduled arrival-time of the alighting stop in this leg.\n\"scheduled time of arrival at alighting stop\" = endTime - arrivalDelay" | |
| type: integer | |
| format: int32 | |
| "boardRule": | |
| type: string | |
| "callAndRide": | |
| description: "True if this is a call-and-ride leg." | |
| type: boolean | |
| "departureDelay": | |
| description: "For transit leg, the offset from the scheduled departure-time of the boarding stop in this leg.\n\"scheduled time of departure at boarding stop\" = startTime - departureDelay" | |
| type: integer | |
| format: int32 | |
| "distance": | |
| description: "The distance traveled while traversing the leg in meters." | |
| type: number | |
| format: double | |
| "endTime": | |
| description: "The date and time this leg ends." | |
| type: string | |
| format: date-time | |
| "flexCallAndRideMaxStartTime": | |
| type: string | |
| format: date-time | |
| "flexCallAndRideMinEndTime": | |
| type: string | |
| format: date-time | |
| "flexDrtAdvanceBookMin": | |
| description: "trip.drt_advance_book_min if this is a demand-response leg" | |
| type: number | |
| format: double | |
| "flexDrtDropOffMessage": | |
| description: "Agency message if this is leg has a demand-response dropoff and the Trip has\n`drt_drop_off_message` defined." | |
| type: string | |
| "flexDrtPickupMessage": | |
| description: "Agency message if this is leg has a demand-response pickup and the Trip has\n`drt_pickup_message` defined." | |
| type: string | |
| "flexFlagStopDropOffMessage": | |
| description: "Agency message if this is leg has a flag stop dropoff and the Trip has\n`continuous_drop_off_message` defined." | |
| type: string | |
| "flexFlagStopPickupMessage": | |
| description: "Agency message if this is leg has a flag stop pickup and the Trip has\n`continuous_pickup_message` defined." | |
| type: string | |
| "from": | |
| $ref: "#/components/schemas/xml_ns0_place" | |
| "headsign": | |
| description: "For transit legs, the headsign of the bus or train being used. For non-transit legs, null." | |
| type: string | |
| "headway": | |
| description: "The best estimate of the time between two arriving vehicles. This is particularly important\nfor non-strict frequency trips, but could become important for real-time trips, strict\nfrequency trips, and scheduled trips with empirical headways." | |
| type: integer | |
| format: int32 | |
| "interlineWithPreviousLeg": | |
| description: "For transit legs, if the rider should stay on the vehicle as it changes route names." | |
| type: boolean | |
| "isNonExactFrequency": | |
| description: "Is this a frequency-based trip with non-strict departure times?" | |
| type: boolean | |
| "legGeometry": | |
| $ref: "#/components/schemas/xml_ns0_encodedPolylineBean" | |
| "mode": | |
| description: "The mode (e.g., <code>Walk</code>) used when traversing this leg." | |
| type: string | |
| "pathway": | |
| description: "Is this leg a traversing pathways?" | |
| type: boolean | |
| "realTime": | |
| description: "Whether there is real-time data about this Leg" | |
| type: boolean | |
| "rentedBike": | |
| type: boolean | |
| "route": | |
| description: "For transit legs, the route of the bus or train being used. For non-transit legs, the name of\nthe street being traversed." | |
| type: string | |
| "routeBrandingUrl": | |
| description: "For transit leg, the route's branding URL (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeColor": | |
| description: "For transit leg, the route's (background) color (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeId": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "routeLongName": | |
| type: string | |
| "routeShortName": | |
| type: string | |
| "routeTextColor": | |
| description: "For transit leg, the route's text color (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeType": | |
| description: "For transit legs, the type of the route. Non transit -1\nWhen 0-7: 0 Tram, 1 Subway, 2 Train, 3 Bus, 4 Ferry, 5 Cable Car, 6 Gondola, 7 Funicular\nWhen equal or highter than 100, it is coded using the Hierarchical Vehicle Type (HVT) codes from the European TPEG standard\nAlso see http://groups.google.com/group/gtfs-changes/msg/ed917a69cf8c5bef" | |
| type: integer | |
| format: int32 | |
| "serviceDate": | |
| description: "For transit legs, the service date of the trip.\nFor non-transit legs, null." | |
| type: string | |
| "startTime": | |
| description: "The date and time this leg begins." | |
| type: string | |
| format: date-time | |
| "stop": | |
| description: "For transit legs, intermediate stops between the Place where the leg originates and the Place where the leg ends.\nFor non-transit legs, null.\nThis field is optional i.e. it is always null unless \"showIntermediateStops\" parameter is set to \"true\" in the planner request." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_place" | |
| "to": | |
| $ref: "#/components/schemas/xml_ns0_place" | |
| "tripBlockId": | |
| description: "For transit leg, the trip's block ID (if one exists). For non-transit legs, null." | |
| type: string | |
| "tripId": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "tripShortName": | |
| description: "For transit leg, the trip's short name (if one exists). For non-transit legs, null." | |
| type: string | |
| "walkSteps": | |
| description: "A series of turn by turn instructions used for walking, biking and driving." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_walkStep" | |
| "xml_ns0_place": | |
| title: "place" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "arrival": | |
| description: "The time the rider will arrive at the place." | |
| type: string | |
| format: date-time | |
| "bikeShareId": | |
| description: "In case the vertex is of type Bike sharing station." | |
| type: string | |
| "boardAlightType": | |
| $ref: "#/components/schemas/xml_ns0_boardAlightType" | |
| "departure": | |
| description: "The time the rider will depart the place." | |
| type: string | |
| format: date-time | |
| "flagStopArea": | |
| $ref: "#/components/schemas/xml_ns0_encodedPolylineBean" | |
| "lat": | |
| description: "The latitude of the place." | |
| type: number | |
| format: double | |
| "lon": | |
| description: "The longitude of the place." | |
| type: number | |
| format: double | |
| "name": | |
| description: "For transit stops, the name of the stop. For points of interest, the name of the POI." | |
| type: string | |
| "orig": | |
| type: string | |
| "platformCode": | |
| description: "The code or name identifying the quay/platform the vehicle will arrive at or depart from" | |
| type: string | |
| "stopCode": | |
| description: "The \"code\" of the stop. Depending on the transit agency, this is often\nsomething that users care about." | |
| type: string | |
| "stopId": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "stopIndex": | |
| description: "For transit trips, the stop index (numbered from zero from the start of the trip" | |
| type: integer | |
| format: int32 | |
| "stopSequence": | |
| description: "For transit trips, the sequence number of the stop. Per GTFS, these numbers are increasing." | |
| type: integer | |
| format: int32 | |
| "vertexType": | |
| $ref: "#/components/schemas/xml_ns0_vertexType" | |
| "zoneId": | |
| type: string | |
| "xml_ns0_relativeDirection": | |
| title: "relativeDirection" | |
| type: string | |
| enum: | |
| - "DEPART" | |
| - "HARD_LEFT" | |
| - "LEFT" | |
| - "SLIGHTLY_LEFT" | |
| - "CONTINUE" | |
| - "SLIGHTLY_RIGHT" | |
| - "RIGHT" | |
| - "HARD_RIGHT" | |
| - "CIRCLE_CLOCKWISE" | |
| - "CIRCLE_COUNTERCLOCKWISE" | |
| - "ELEVATOR" | |
| - "UTURN_LEFT" | |
| - "UTURN_RIGHT" | |
| "xml_ns0_routerInfo": | |
| title: "routerInfo" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "centerLatitude" | |
| - "centerLongitude" | |
| - "hasParkRide" | |
| - "transitServiceEnds" | |
| - "transitServiceStarts" | |
| properties: | |
| "buildTime": | |
| type: string | |
| format: date-time | |
| "centerLatitude": | |
| type: number | |
| format: double | |
| "centerLongitude": | |
| type: number | |
| format: double | |
| "hasParkRide": | |
| type: boolean | |
| "polygon": | |
| $ref: "#/components/schemas/xml_ns0_geometry" | |
| "routerId": | |
| type: string | |
| "transitModes": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_TraverseMode" | |
| "transitServiceEnds": | |
| type: integer | |
| format: int64 | |
| "transitServiceStarts": | |
| type: integer | |
| format: int64 | |
| "travelOptions": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_travelOption" | |
| "xml_ns0_routerList": | |
| title: "routerList" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "routerInfo": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_routerInfo" | |
| "xml_ns0_tripPlan": | |
| title: "tripPlan" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "date": | |
| description: "The time and date of travel" | |
| type: string | |
| format: date-time | |
| "from": | |
| $ref: "#/components/schemas/xml_ns0_place" | |
| "itinerary": | |
| description: "A list of possible itineraries" | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_itinerary" | |
| "to": | |
| $ref: "#/components/schemas/xml_ns0_place" | |
| "xml_ns0_vertexType": | |
| title: "vertexType" | |
| type: string | |
| enum: | |
| - "NORMAL" | |
| - "BIKESHARE" | |
| - "BIKEPARK" | |
| - "TRANSIT" | |
| "xml_ns0_walkStep": | |
| title: "walkStep" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "distance" | |
| - "lat" | |
| - "lon" | |
| properties: | |
| "absoluteDirection": | |
| $ref: "#/components/schemas/xml_ns0_absoluteDirection" | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_localizedAlert" | |
| "area": | |
| description: "This step is on an open area, such as a plaza or train platform, and thus the directions should say something like \"cross\"" | |
| type: boolean | |
| "bogusName": | |
| description: "The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions" | |
| type: boolean | |
| "distance": | |
| description: "The distance in meters that this step takes." | |
| type: number | |
| format: double | |
| "elevation": | |
| description: "The elevation profile as a comma-separated list of x,y values. x is the distance from the start of the step, y is the elevation at this\ndistance." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_p2" | |
| "exit": | |
| description: "When exiting a highway or traffic circle, the exit name/number." | |
| type: string | |
| "lat": | |
| description: "The latitude of start of the step" | |
| type: number | |
| format: double | |
| "lon": | |
| description: "The longitude of start of the step" | |
| type: number | |
| format: double | |
| "relativeDirection": | |
| $ref: "#/components/schemas/xml_ns0_relativeDirection" | |
| "stayOn": | |
| description: "Indicates whether or not a street changes direction at an intersection." | |
| type: boolean | |
| "streetName": | |
| description: "The name of the street." | |
| type: string | |
| "xml_ns0_alertPatchCreationResponse": | |
| title: "alertPatchCreationResponse" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "status": | |
| type: string | |
| "xml_ns0_alertPatchResponse": | |
| title: "alertPatchResponse" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "alertPatches": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_alertPatch" | |
| "xml_ns0_alertPatchSet": | |
| title: "alertPatchSet" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "alertPatches": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_alertPatch" | |
| "xml_ns0_localizedAlert": | |
| title: "localizedAlert" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "alert": | |
| $ref: "#/components/schemas/xml_ns0_alert" | |
| "xml_ns0_plannerError": | |
| title: "plannerError" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "id" | |
| - "noPath" | |
| properties: | |
| "id": | |
| type: integer | |
| format: int32 | |
| "message": | |
| $ref: "#/components/schemas/xml_ns0_message" | |
| "missing": | |
| description: "the list of point names which cannot be found (from, to, intermediate.n)" | |
| type: array | |
| items: | |
| type: string | |
| "msg": | |
| type: string | |
| "noPath": | |
| description: "whether no path has been found" | |
| type: boolean | |
| "xml_ns0_bikeRentalStationList": | |
| title: "bikeRentalStationList" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "stations": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_bikeRentalStation" | |
| "xml_ns0_debugOutput": | |
| title: "debugOutput" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "pathCalculationTime" | |
| - "precalculationTime" | |
| - "renderingTime" | |
| - "timedOut" | |
| - "totalTime" | |
| properties: | |
| "pathCalculationTime": | |
| type: integer | |
| format: int64 | |
| "pathTimes": | |
| type: array | |
| items: | |
| type: integer | |
| format: int64 | |
| "precalculationTime": | |
| type: integer | |
| format: int64 | |
| "renderingTime": | |
| type: integer | |
| format: int64 | |
| "timedOut": | |
| type: boolean | |
| "totalTime": | |
| type: integer | |
| format: int64 | |
| xml: | |
| name: debugOutput | |
| "xml_ns0_elevationMetadata": | |
| title: "elevationMetadata" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "ellipsoidToGeoidDifference": | |
| type: number | |
| format: double | |
| "geoidElevation": | |
| type: boolean | |
| "xml_ns0_inspectorLayersList": | |
| title: "inspectorLayersList" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "layers": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_inspectorLayer" | |
| "xml_ns0_inspectorLayer": | |
| title: "inspectorLayer" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| "xml_ns0_response": | |
| title: "response" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "debugOutput": | |
| $ref: "#/components/schemas/xml_ns0_debugOutput" | |
| "elevationMetadata": | |
| $ref: "#/components/schemas/xml_ns0_elevationMetadata" | |
| "error": | |
| $ref: "#/components/schemas/xml_ns0_plannerError" | |
| "plan": | |
| $ref: "#/components/schemas/xml_ns0_tripPlan" | |
| "requestParameters": | |
| description: "A dictionary of the parameters provided in the request that triggered this response." | |
| type: object | |
| additionalProperties: | |
| type: string | |
| "xml_ns0_serverInfo": | |
| title: "serverInfo" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "nCores" | |
| properties: | |
| "cpuName": | |
| type: string | |
| "nCores": | |
| type: integer | |
| format: int32 | |
| "serverVersion": | |
| $ref: "#/components/schemas/xml_ns0_mavenVersion" | |
| "xml_ns0_mavenVersion": | |
| title: "mavenVersion" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "incremental" | |
| - "major" | |
| - "minor" | |
| properties: | |
| "build_time": | |
| type: string | |
| "commit": | |
| type: string | |
| "commit_time": | |
| type: string | |
| "describe": | |
| type: string | |
| "incremental": | |
| type: integer | |
| format: int32 | |
| "major": | |
| type: integer | |
| format: int32 | |
| "minor": | |
| type: integer | |
| format: int32 | |
| "qualifier": | |
| type: string | |
| "version": | |
| type: string | |
| "xml_ns0_p2": | |
| title: "p2" | |
| allOf: | |
| - $ref: "#/components/schemas/xml_ns0_t2" | |
| - type: object | |
| "xml_ns0_t2": | |
| title: "t2" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "first": | |
| type: string | |
| format: binary | |
| "second": | |
| type: string | |
| format: binary | |
| "xml_ns0_feedScopedId": | |
| title: "feedScopedId" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "agencyId": | |
| type: string | |
| "id": | |
| type: string | |
| "xml_ns0_alert": | |
| title: "alert" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "alertDescriptionText": | |
| type: string | |
| format: binary | |
| "alertHeaderText": | |
| type: string | |
| format: binary | |
| "alertUrl": | |
| type: string | |
| format: binary | |
| "effectiveEndDate": | |
| type: string | |
| format: date-time | |
| "effectiveStartDate": | |
| type: string | |
| format: date-time | |
| "xml_ns0_alertPatch": | |
| title: "alertPatch" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "directionId" | |
| properties: | |
| "alert": | |
| $ref: "#/components/schemas/xml_ns0_alert" | |
| "direction": | |
| type: string | |
| "directionId": | |
| type: integer | |
| format: int32 | |
| "feedId": | |
| type: string | |
| "id": | |
| type: string | |
| "route": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "stop": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "trip": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "xml_ns0_bikeRentalStation": | |
| title: "bikeRentalStation" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "allowDropoff" | |
| - "bikesAvailable" | |
| - "isCarStation" | |
| - "isFloatingBike" | |
| - "realTimeData" | |
| - "spacesAvailable" | |
| - "x" | |
| properties: | |
| "allowDropoff": | |
| type: boolean | |
| "bikesAvailable": | |
| type: integer | |
| format: int32 | |
| "id": | |
| type: string | |
| "isCarStation": | |
| type: boolean | |
| "isFloatingBike": | |
| type: boolean | |
| "locale": | |
| $ref: "#/components/schemas/xml_ns0_locale" | |
| "name": | |
| type: string | |
| format: binary | |
| "networks": | |
| description: "List of compatible network names. Null (default) to be compatible with all." | |
| type: array | |
| items: | |
| type: string | |
| "realTimeData": | |
| description: "Whether this station is static (usually coming from OSM data) or a real-time source. If no real-time data, users should take\nbikesAvailable/spacesAvailable with a pinch of salt, as they are always the total capacity divided by two. Only the total is meaningful." | |
| type: boolean | |
| "spacesAvailable": | |
| type: integer | |
| format: int32 | |
| "x": | |
| type: number | |
| format: double | |
| "xml_ns0_fare": | |
| title: "fare" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "details": | |
| description: "A mapping from FareType to a list of FareComponent.\nThe FareComponents are stored in an array instead of a list because JAXB doesn't know how to deal with\ninterfaces when serializing a trip planning response, and List is an interface.\nSee https://stackoverflow.com/a/1119241/778449" | |
| type: string | |
| format: binary | |
| "fare": | |
| description: "A mapping from FareType to Money." | |
| type: string | |
| format: binary | |
| "xml_ns0_fareType": | |
| title: "fareType" | |
| type: string | |
| enum: | |
| - "regular" | |
| - "student" | |
| - "senior" | |
| - "tram" | |
| - "special" | |
| - "youth" | |
| "xml_ns0_fareComponent": | |
| title: "fareComponent" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "fareId": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "price": | |
| $ref: "#/components/schemas/xml_ns0_money" | |
| "routes": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "xml_ns0_money": | |
| title: "money" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "cents" | |
| properties: | |
| "cents": | |
| type: integer | |
| format: int32 | |
| "currency": | |
| $ref: "#/components/schemas/xml_ns0_wrappedCurrency" | |
| "xml_ns0_TraverseMode": | |
| title: "TraverseMode" | |
| type: string | |
| enum: | |
| - "WALK" | |
| - "BICYCLE" | |
| - "CAR" | |
| - "TRAM" | |
| - "SUBWAY" | |
| - "RAIL" | |
| - "BUS" | |
| - "FERRY" | |
| - "CABLE_CAR" | |
| - "GONDOLA" | |
| - "FUNICULAR" | |
| - "TRANSIT" | |
| - "LEG_SWITCH" | |
| - "AIRPLANE" | |
| "xml_ns0_wrappedCurrency": | |
| title: "wrappedCurrency" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| "xml_ns0_i18NString": | |
| oneOf: | |
| - $ref: "#/components/schemas/xml_ns0_localizedString" | |
| - $ref: "#/components/schemas/xml_ns0_nonLocalizedString" | |
| - $ref: "#/components/schemas/xml_ns0_translatedString" | |
| "xml_ns0_localizedString": | |
| title: "localizedString" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| "xml_ns0_nonLocalizedString": | |
| title: "nonLocalizedString" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| "xml_ns0_translatedString": | |
| title: "translatedString" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| "xml_ns0_travelOption": | |
| title: "travelOption" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "name": | |
| type: string | |
| "value": | |
| type: string | |
| "xml_ns0_encodedPolylineBean": | |
| title: "encodedPolylineBean" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "length" | |
| properties: | |
| "length": | |
| description: "The number of points in the string" | |
| type: integer | |
| format: int32 | |
| "levels": | |
| description: "Levels describes which points should be shown at various zoom levels. Presently, we show all\npoints at all zoom levels." | |
| type: string | |
| "points": | |
| description: "The encoded points of the polyline." | |
| type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment