-
-
Save tarbaig/4572e0d1dcbc64f67c462ec2d53b7f27 to your computer and use it in GitHub Desktop.
Openapi.yml generated from OTP dev-2.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: "2.0.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}/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\nTriMet_100 (100 is route short name) or Trimet__42 (two underscores, 42 is the route\ninternal 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: "debugItineraryFilter" | |
| 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: "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).\nParameter 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.\n\nConsider using the #transferPenalty instead of this parameter." | |
| 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: "The set of modes that a user is willing to use, with qualifiers stating whether vehicles\nshould be parked, rented, etc.\n<p>\nThe possible values of the comma-separated list are:\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\nFor a more complete discussion of this parameter see\n<a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>." | |
| 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.\n\nTODO OTP2 This JavaDoc needs clarification. What is a \"preferred\" Transfer, the GTFS\nspecification do not have \"preferred Transfers\". The GTFS spec transfer\ntype 0 is _Recommended transfer point_ - is this what is meant?" | |
| 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\npreferred, i.e. number of seconds that we are willing to 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\n(100 is route short name) or Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "THIS PARAMETER IS NO LONGER IN USE.\n\nIf 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: "searchWindow" | |
| in: query | |
| description: "This is the time/duration in seconds from the earliest-departure-time(EDT) to\nlatest-departure-time(LDT). In case of a reverse search it will be the time from earliest\nto latest arrival time (LAT minus EAT).\n<p>\nAll optimal travels that depart within the search window is guarantied to be found.\n<p>\nThis is sometimes referred to as the Range Raptor Search Window - but should apply to all\nscheduled/time dependent travels.\n<p>\nOptional - it is NOT recommended to set this value, unless you use the value returned by the\nprevious search. Then it can be used to get the next/previous \"page\". The value is\ndynamically assigned a suitable value, if not set. In a small to medium size operation\nyou may use a fixed value, like 60 minutes. If you have a mixture of high frequency cities\nroutes and infrequent long distant journeys, the best option is normally to use the dynamic\nauto assignment." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| 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\n(100 is route short name) or Trimet__42 (two underscores, 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\nTriMet_100 (100 is route short name) or Trimet__42 (two underscores, 42 is the route\ninternal 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: "debugItineraryFilter" | |
| 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: "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).\nParameter 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.\n\nConsider using the #transferPenalty instead of this parameter." | |
| 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: "The set of modes that a user is willing to use, with qualifiers stating whether vehicles\nshould be parked, rented, etc.\n<p>\nThe possible values of the comma-separated list are:\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\nFor a more complete discussion of this parameter see\n<a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>." | |
| 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.\n\nTODO OTP2 This JavaDoc needs clarification. What is a \"preferred\" Transfer, the GTFS\nspecification do not have \"preferred Transfers\". The GTFS spec transfer\ntype 0 is _Recommended transfer point_ - is this what is meant?" | |
| 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\npreferred, i.e. number of seconds that we are willing to 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\n(100 is route short name) or Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "THIS PARAMETER IS NO LONGER IN USE.\n\nIf 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: "searchWindow" | |
| in: query | |
| description: "This is the time/duration in seconds from the earliest-departure-time(EDT) to\nlatest-departure-time(LDT). In case of a reverse search it will be the time from earliest\nto latest arrival time (LAT minus EAT).\n<p>\nAll optimal travels that depart within the search window is guarantied to be found.\n<p>\nThis is sometimes referred to as the Range Raptor Search Window - but should apply to all\nscheduled/time dependent travels.\n<p>\nOptional - it is NOT recommended to set this value, unless you use the value returned by the\nprevious search. Then it can be used to get the next/previous \"page\". The value is\ndynamically assigned a suitable value, if not set. In a small to medium size operation\nyou may use a fixed value, like 60 minutes. If you have a mixture of high frequency cities\nroutes and infrequent long distant journeys, the best option is normally to use the dynamic\nauto assignment." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| 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\n(100 is route short name) or Trimet__42 (two underscores, 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/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/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/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/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 | |
| "/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\nTriMet_100 (100 is route short name) or Trimet__42 (two underscores, 42 is the route\ninternal 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: "debugItineraryFilter" | |
| 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: "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).\nParameter 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.\n\nConsider using the #transferPenalty instead of this parameter." | |
| 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: "The set of modes that a user is willing to use, with qualifiers stating whether vehicles\nshould be parked, rented, etc.\n<p>\nThe possible values of the comma-separated list are:\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\nFor a more complete discussion of this parameter see\n<a href=\"http://docs.opentripplanner.org/en/latest/Configuration/#routing-modes\">Routing modes</a>." | |
| 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.\n\nTODO OTP2 This JavaDoc needs clarification. What is a \"preferred\" Transfer, the GTFS\nspecification do not have \"preferred Transfers\". The GTFS spec transfer\ntype 0 is _Recommended transfer point_ - is this what is meant?" | |
| 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\npreferred, i.e. number of seconds that we are willing to 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\n(100 is route short name) or Trimet__42 (two underscores, 42 is the route internal ID)." | |
| required: false | |
| schema: | |
| type: string | |
| style: form | |
| - name: "reverseOptimizeOnTheFly" | |
| in: query | |
| description: "THIS PARAMETER IS NO LONGER IN USE.\n\nIf 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: "searchWindow" | |
| in: query | |
| description: "This is the time/duration in seconds from the earliest-departure-time(EDT) to\nlatest-departure-time(LDT). In case of a reverse search it will be the time from earliest\nto latest arrival time (LAT minus EAT).\n<p>\nAll optimal travels that depart within the search window is guarantied to be found.\n<p>\nThis is sometimes referred to as the Range Raptor Search Window - but should apply to all\nscheduled/time dependent travels.\n<p>\nOptional - it is NOT recommended to set this value, unless you use the value returned by the\nprevious search. Then it can be used to get the next/previous \"page\". The value is\ndynamically assigned a suitable value, if not set. In a small to medium size operation\nyou may use a fixed value, like 60 minutes. If you have a mixture of high frequency cities\nroutes and infrequent long distant journeys, the best option is normally to use the dynamic\nauto assignment." | |
| required: false | |
| schema: | |
| type: integer | |
| format: int32 | |
| 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\n(100 is route short name) or Trimet__42 (two underscores, 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" | |
| "": | |
| get: | |
| description: "" | |
| tags: | |
| - "ServerInfo" | |
| summary: "" | |
| deprecated: false | |
| operationId: getServerInfo | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| "*/*": | |
| schema: | |
| $ref: "#/components/schemas/ServerInfo" | |
| "/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: | |
| "Alert": | |
| title: "Alert" | |
| type: object | |
| properties: | |
| "alertHeaderText": | |
| $ref: "#/components/schemas/I18NString" | |
| "alertDescriptionText": | |
| $ref: "#/components/schemas/I18NString" | |
| "alertDetailText": | |
| $ref: "#/components/schemas/I18NString" | |
| "alertAdviceText": | |
| $ref: "#/components/schemas/I18NString" | |
| "alertUrl": | |
| $ref: "#/components/schemas/I18NString" | |
| "effectiveStartDate": | |
| type: integer | |
| format: int32 | |
| "effectiveEndDate": | |
| type: integer | |
| format: int32 | |
| "alertType": | |
| type: string | |
| "severity": | |
| type: string | |
| "alertUrlList": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/AlertUrl" | |
| example: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertDetailText: {} | |
| alertAdviceText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| alertType: "..." | |
| severity: "..." | |
| alertUrlList: | |
| - uri: "..." | |
| label: "..." | |
| - uri: "..." | |
| label: "..." | |
| "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 | |
| "stopConditions": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/StopCondition" | |
| "situationNumber": | |
| type: string | |
| example: | |
| alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertDetailText: {} | |
| alertAdviceText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| alertType: "..." | |
| severity: "..." | |
| alertUrlList: | |
| - uri: "..." | |
| label: "..." | |
| - uri: "..." | |
| label: "..." | |
| id: "..." | |
| agency: "..." | |
| route: | |
| feedId: "..." | |
| id: "..." | |
| trip: | |
| feedId: "..." | |
| id: "..." | |
| stop: | |
| feedId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| stopConditions: | |
| - "DESTINATION" | |
| - "EXCEPTIONAL_STOP" | |
| situationNumber: "..." | |
| "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: {} | |
| alertDetailText: {} | |
| alertAdviceText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| alertType: "..." | |
| severity: "..." | |
| alertUrlList: | |
| - {} | |
| - {} | |
| id: "..." | |
| agency: "..." | |
| route: | |
| feedId: "..." | |
| id: "..." | |
| trip: | |
| feedId: "..." | |
| id: "..." | |
| stop: | |
| feedId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| stopConditions: | |
| - "EXCEPTIONAL_STOP" | |
| - "NOT_STOPPING" | |
| situationNumber: "..." | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertDetailText: {} | |
| alertAdviceText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| alertType: "..." | |
| severity: "..." | |
| alertUrlList: | |
| - {} | |
| - {} | |
| id: "..." | |
| agency: "..." | |
| route: | |
| feedId: "..." | |
| id: "..." | |
| trip: | |
| feedId: "..." | |
| id: "..." | |
| stop: | |
| feedId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| stopConditions: | |
| - "STOP" | |
| - "REQUEST_STOP" | |
| situationNumber: "..." | |
| "AlertPatchSet": | |
| title: "AlertPatchSet" | |
| type: object | |
| properties: | |
| "alertPatches": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/AlertPatch" | |
| example: | |
| alertPatches: | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertDetailText: {} | |
| alertAdviceText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| alertType: "..." | |
| severity: "..." | |
| alertUrlList: | |
| - {} | |
| - {} | |
| id: "..." | |
| agency: "..." | |
| route: | |
| feedId: "..." | |
| id: "..." | |
| trip: | |
| feedId: "..." | |
| id: "..." | |
| stop: | |
| feedId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| stopConditions: | |
| - "EXCEPTIONAL_STOP" | |
| - "START_POINT" | |
| situationNumber: "..." | |
| - alert: | |
| alertHeaderText: {} | |
| alertDescriptionText: {} | |
| alertDetailText: {} | |
| alertAdviceText: {} | |
| alertUrl: {} | |
| effectiveStartDate: 12345 | |
| effectiveEndDate: 12345 | |
| alertType: "..." | |
| severity: "..." | |
| alertUrlList: | |
| - {} | |
| - {} | |
| id: "..." | |
| agency: "..." | |
| route: | |
| feedId: "..." | |
| id: "..." | |
| trip: | |
| feedId: "..." | |
| id: "..." | |
| stop: | |
| feedId: "..." | |
| id: "..." | |
| direction: "..." | |
| directionId: 12345 | |
| feedId: "..." | |
| stopConditions: | |
| - "DESTINATION" | |
| - "REQUEST_STOP" | |
| situationNumber: "..." | |
| "AlertUrl": | |
| title: "AlertUrl" | |
| type: object | |
| properties: | |
| "uri": | |
| type: string | |
| "label": | |
| type: string | |
| example: | |
| uri: "..." | |
| label: "..." | |
| "ApiAbsoluteDirection": | |
| title: "ApiAbsoluteDirection" | |
| type: string | |
| enum: | |
| - "NORTH" | |
| - "NORTHEAST" | |
| - "EAST" | |
| - "SOUTHEAST" | |
| - "SOUTH" | |
| - "SOUTHWEST" | |
| - "WEST" | |
| - "NORTHWEST" | |
| "ApiAlert": | |
| title: "ApiAlert" | |
| type: object | |
| properties: | |
| "alertHeaderText": | |
| type: string | |
| "alertDescriptionText": | |
| type: string | |
| "alertUrl": | |
| type: string | |
| "effectiveStartDate": | |
| type: integer | |
| format: int32 | |
| example: | |
| alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| "ApiItinerary": | |
| title: "ApiItinerary" | |
| type: object | |
| required: | |
| - "walkTime" | |
| - "transitTime" | |
| - "waitingTime" | |
| - "walkLimitExceeded" | |
| - "tooSloped" | |
| properties: | |
| "debugMarkedAsDeleted": | |
| description: "The Itinerary filter may mark itineraries as deleted in stead of actually deleting them. This\nis very handy, when tuning the system or debugging - looking for missing expected trips.\n<p>\nDefault is null - flag is not returned unless set to true." | |
| type: boolean | |
| "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" | |
| "leg": | |
| 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/ApiLeg" | |
| "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: | |
| debugMarkedAsDeleted: 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: | |
| currency: {} | |
| cents: 12345 | |
| property2: | |
| currency: {} | |
| cents: 12345 | |
| details: | |
| property1: | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| property2: | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| - fareId: {} | |
| price: {} | |
| routes: | |
| - {} | |
| - {} | |
| leg: | |
| - 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: | |
| feedId: "..." | |
| id: "..." | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: | |
| feedId: "..." | |
| 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: "..." | |
| geometry: "..." | |
| to: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "TRANSIT" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| intermediateStops: | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "TRANSIT" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| legGeometry: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| steps: | |
| - distance: 12345.0 | |
| relativeDirection: "SLIGHTLY_RIGHT" | |
| streetName: "..." | |
| absoluteDirection: "NORTHWEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: "..." | |
| alerts: | |
| - {} | |
| - {} | |
| - distance: 12345.0 | |
| relativeDirection: "DEPART" | |
| streetName: "..." | |
| absoluteDirection: "EAST" | |
| 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 | |
| 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: | |
| feedId: "..." | |
| id: "..." | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: | |
| feedId: "..." | |
| 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: "BIKEPARK" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| to: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| intermediateStops: | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKESHARE" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| - name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| legGeometry: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| steps: | |
| - distance: 12345.0 | |
| relativeDirection: "ELEVATOR" | |
| streetName: "..." | |
| absoluteDirection: "SOUTH" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: "..." | |
| alerts: | |
| - {} | |
| - {} | |
| - distance: 12345.0 | |
| relativeDirection: "HARD_LEFT" | |
| streetName: "..." | |
| absoluteDirection: "NORTHEAST" | |
| 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 | |
| transitLeg: true | |
| duration: 12345.0 | |
| tooSloped: true | |
| "ApiLeg": | |
| title: "ApiLeg" | |
| type: object | |
| required: | |
| - "departureDelay" | |
| - "arrivalDelay" | |
| - "agencyTimeZoneOffset" | |
| - "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/ApiPlace" | |
| "to": | |
| $ref: "#/components/schemas/ApiPlace" | |
| "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/ApiPlace" | |
| "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/ApiWalkStep" | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/ApiAlert" | |
| "routeShortName": | |
| type: string | |
| "routeLongName": | |
| type: string | |
| "boardRule": | |
| type: string | |
| "alightRule": | |
| type: string | |
| "rentedBike": | |
| type: boolean | |
| "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: | |
| feedId: "..." | |
| id: "..." | |
| routeTextColor: "..." | |
| interlineWithPreviousLeg: true | |
| tripShortName: "..." | |
| tripBlockId: "..." | |
| headsign: "..." | |
| agencyId: "..." | |
| tripId: | |
| feedId: "..." | |
| id: "..." | |
| serviceDate: "..." | |
| routeBrandingUrl: "..." | |
| from: | |
| name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| to: | |
| name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| intermediateStops: | |
| - name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKESHARE" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| - name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "TRANSIT" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| legGeometry: | |
| points: "..." | |
| levels: "..." | |
| length: 12345 | |
| steps: | |
| - distance: 12345.0 | |
| relativeDirection: "CIRCLE_CLOCKWISE" | |
| streetName: "..." | |
| absoluteDirection: "NORTHWEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: "..." | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - distance: 12345.0 | |
| relativeDirection: "UTURN_LEFT" | |
| streetName: "..." | |
| absoluteDirection: "WEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: "..." | |
| 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 | |
| transitLeg: true | |
| duration: 12345.0 | |
| "ApiPlace": | |
| title: "ApiPlace" | |
| 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/ApiVertexType" | |
| "bikeShareId": | |
| description: "In case the vertex is of type Bike sharing station." | |
| type: string | |
| "geometry": | |
| description: "Returns the geometry in GeoJSON format" | |
| type: string | |
| example: | |
| name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKEPARK" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| "ApiRelativeDirection": | |
| title: "ApiRelativeDirection" | |
| type: string | |
| enum: | |
| - "DEPART" | |
| - "HARD_LEFT" | |
| - "LEFT" | |
| - "SLIGHTLY_LEFT" | |
| - "CONTINUE" | |
| - "SLIGHTLY_RIGHT" | |
| - "RIGHT" | |
| - "HARD_RIGHT" | |
| - "CIRCLE_CLOCKWISE" | |
| - "CIRCLE_COUNTERCLOCKWISE" | |
| - "ELEVATOR" | |
| - "UTURN_LEFT" | |
| - "UTURN_RIGHT" | |
| "ApiTripPlan": | |
| title: "ApiTripPlan" | |
| type: object | |
| properties: | |
| "date": | |
| description: "The time and date of travel" | |
| type: integer | |
| format: int32 | |
| "from": | |
| $ref: "#/components/schemas/ApiPlace" | |
| "to": | |
| $ref: "#/components/schemas/ApiPlace" | |
| "itineraries": | |
| description: "A list of possible itineraries. The wrapper is named 'itineraries' while the\nelements them self is named 'itinerary'." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/ApiItinerary" | |
| example: | |
| date: 12345 | |
| from: | |
| name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "BIKESHARE" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| to: | |
| name: "..." | |
| stopId: | |
| feedId: "..." | |
| id: "..." | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| itineraries: | |
| - debugMarkedAsDeleted: 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: | |
| - {} | |
| - {} | |
| leg: | |
| - 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 | |
| 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 | |
| transitLeg: true | |
| duration: 12345.0 | |
| tooSloped: true | |
| - debugMarkedAsDeleted: 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: | |
| - {} | |
| - {} | |
| leg: | |
| - 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 | |
| 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 | |
| transitLeg: true | |
| duration: 12345.0 | |
| tooSloped: true | |
| "ApiTripSearchMetadata": | |
| title: "ApiTripSearchMetadata" | |
| type: object | |
| required: | |
| - "searchWindowUsed" | |
| properties: | |
| "searchWindowUsed": | |
| description: "This is the time window used by the raptor search. The window is an optional parameter and\nOTP might override it/dynamically assign a new value.\n<p>\nUnit : seconds" | |
| type: integer | |
| format: int32 | |
| "nextDateTime": | |
| description: "This is the suggested search time for the \"next page\" or time window. Insert it together\nwith the #searchWindowUsed in the request to get a new set of trips following in the\ntime-window AFTER the current search. No duplicate trips should be returned, unless a trip\nis delayed and new realtime-data is available.\n<p>\nIf OTP for some reason is not able to calculate this value then it will be null.\n<p>\nUnit : epoch milliseconds" | |
| type: integer | |
| format: int64 | |
| "prevDateTime": | |
| description: "This is the suggested search time for the \"previous page\" or time window. Insert it together\nwith the #searchWindowUsed in the request to get a new set of trips preceding in the\ntime-window BEFORE the current search. No duplicate trips should be returned, unless a trip\nis delayed and new realtime-data is available.\n<p>\nIf OTP for some reason is not able to calculate this value then it will be null.\n<p>\nUnit : epoch milliseconds" | |
| type: integer | |
| format: int64 | |
| example: | |
| searchWindowUsed: 12345 | |
| nextDateTime: 12345 | |
| prevDateTime: 12345 | |
| "ApiVertexType": | |
| title: "ApiVertexType" | |
| type: string | |
| enum: | |
| - "NORMAL" | |
| - "BIKESHARE" | |
| - "BIKEPARK" | |
| - "TRANSIT" | |
| "ApiWalkStep": | |
| title: "ApiWalkStep" | |
| 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/ApiRelativeDirection" | |
| "streetName": | |
| description: "The name of the street." | |
| type: string | |
| "absoluteDirection": | |
| $ref: "#/components/schemas/ApiAbsoluteDirection" | |
| "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: string | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/ApiAlert" | |
| example: | |
| distance: 12345.0 | |
| relativeDirection: "DEPART" | |
| streetName: "..." | |
| absoluteDirection: "SOUTHWEST" | |
| exit: "..." | |
| stayOn: true | |
| area: true | |
| bogusName: true | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| elevation: "..." | |
| alerts: | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| - alertHeaderText: "..." | |
| alertDescriptionText: "..." | |
| alertUrl: "..." | |
| effectiveStartDate: 12345 | |
| "BikeRentalStationList": | |
| title: "BikeRentalStationList" | |
| type: object | |
| properties: | |
| "stations": | |
| type: array | |
| items: | |
| type: string | |
| format: binary | |
| example: | |
| stations: | |
| - {} | |
| - {} | |
| "DEFAULT": | |
| title: "DEFAULT" | |
| type: object | |
| example: | |
| "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: | |
| "key": | |
| type: string | |
| "value": | |
| type: string | |
| example: | |
| key: "..." | |
| value: "..." | |
| "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: | |
| feedId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - feedId: "..." | |
| id: "..." | |
| - feedId: "..." | |
| id: "..." | |
| - fareId: | |
| feedId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - feedId: "..." | |
| id: "..." | |
| - feedId: "..." | |
| id: "..." | |
| property2: | |
| - fareId: | |
| feedId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - feedId: "..." | |
| id: "..." | |
| - feedId: "..." | |
| id: "..." | |
| - fareId: | |
| feedId: "..." | |
| id: "..." | |
| price: | |
| currency: {} | |
| cents: 12345 | |
| routes: | |
| - feedId: "..." | |
| id: "..." | |
| - feedId: "..." | |
| 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: | |
| feedId: "..." | |
| id: "..." | |
| price: | |
| currency: | |
| defaultFractionDigits: 12345 | |
| currencyCode: "..." | |
| symbol: "..." | |
| currency: "..." | |
| cents: 12345 | |
| routes: | |
| - feedId: "..." | |
| id: "..." | |
| - feedId: "..." | |
| id: "..." | |
| "FareType": | |
| title: "FareType" | |
| type: string | |
| enum: | |
| - "regular" | |
| - "student" | |
| - "senior" | |
| - "tram" | |
| - "special" | |
| - "youth" | |
| "FeedScopedId": | |
| title: "FeedScopedId" | |
| type: object | |
| properties: | |
| "feedId": | |
| type: string | |
| "id": | |
| type: string | |
| example: | |
| feedId: "..." | |
| 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 | |
| "I18NString": | |
| oneOf: | |
| - $ref: "#/components/schemas/LocalizedString" | |
| - $ref: "#/components/schemas/NonLocalizedString" | |
| - $ref: "#/components/schemas/TranslatedString" | |
| "InspectorLayersList": | |
| title: "InspectorLayersList" | |
| type: object | |
| properties: | |
| "layers": | |
| type: array | |
| items: | |
| type: string | |
| format: binary | |
| example: | |
| layers: | |
| - {} | |
| - {} | |
| "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: | |
| "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: "TRIANGLE_NOT_AFFINE" | |
| missing: | |
| - "..." | |
| - "..." | |
| noPath: true | |
| "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/ApiTripPlan" | |
| "metadata": | |
| $ref: "#/components/schemas/ApiTripSearchMetadata" | |
| "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: "TRANSIT" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| to: | |
| name: "..." | |
| stopId: {} | |
| stopCode: "..." | |
| platformCode: "..." | |
| lon: 12345.0 | |
| lat: 12345.0 | |
| arrival: 12345 | |
| departure: 12345 | |
| orig: "..." | |
| zoneId: "..." | |
| stopIndex: 12345 | |
| stopSequence: 12345 | |
| vertexType: "NORMAL" | |
| bikeShareId: "..." | |
| geometry: "..." | |
| itineraries: | |
| - debugMarkedAsDeleted: 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: {} | |
| leg: | |
| - {} | |
| - {} | |
| tooSloped: true | |
| - debugMarkedAsDeleted: 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: {} | |
| leg: | |
| - {} | |
| - {} | |
| tooSloped: true | |
| metadata: | |
| searchWindowUsed: 12345 | |
| nextDateTime: 12345 | |
| prevDateTime: 12345 | |
| error: | |
| id: 12345 | |
| msg: "..." | |
| message: "SYSTEM_ERROR" | |
| missing: | |
| - "..." | |
| - "..." | |
| noPath: true | |
| "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 | |
| "StopCondition": | |
| title: "StopCondition" | |
| type: string | |
| enum: | |
| - "START_POINT" | |
| - "DESTINATION" | |
| - "NOT_STOPPING" | |
| - "EXCEPTIONAL_STOP" | |
| - "REQUEST_STOP" | |
| - "STOP" | |
| "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: | |
| - key: "..." | |
| value: "..." | |
| - key: "..." | |
| value: "..." | |
| "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_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_apiAbsoluteDirection": | |
| title: "apiAbsoluteDirection" | |
| type: string | |
| enum: | |
| - "NORTH" | |
| - "NORTHEAST" | |
| - "EAST" | |
| - "SOUTHEAST" | |
| - "SOUTH" | |
| - "SOUTHWEST" | |
| - "WEST" | |
| - "NORTHWEST" | |
| "xml_ns0_apiItinerary": | |
| title: "apiItinerary" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "tooSloped" | |
| - "transitTime" | |
| - "waitingTime" | |
| - "walkLimitExceeded" | |
| - "walkTime" | |
| properties: | |
| "debugMarkedAsDeleted": | |
| description: "The Itinerary filter may mark itineraries as deleted in stead of actually deleting them. This\nis very handy, when tuning the system or debugging - looking for missing expected trips.\n<p>\nDefault is null - flag is not returned unless set to true." | |
| type: boolean | |
| "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" | |
| "leg": | |
| xml: | |
| name: legs | |
| wrapped: true | |
| 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_apiLeg" | |
| "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_apiLeg": | |
| title: "apiLeg" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "agencyTimeZoneOffset" | |
| - "arrivalDelay" | |
| - "departureDelay" | |
| - "duration" | |
| properties: | |
| "agencyBrandingUrl": | |
| xml: | |
| attribute: true | |
| type: string | |
| "agencyId": | |
| xml: | |
| attribute: true | |
| 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": | |
| xml: | |
| attribute: true | |
| type: string | |
| "agencyTimeZoneOffset": | |
| xml: | |
| attribute: true | |
| type: integer | |
| format: int32 | |
| "agencyUrl": | |
| xml: | |
| attribute: true | |
| type: string | |
| "alightRule": | |
| xml: | |
| attribute: true | |
| type: string | |
| "boardRule": | |
| xml: | |
| attribute: true | |
| type: string | |
| "headsign": | |
| xml: | |
| attribute: true | |
| description: "For transit legs, the headsign of the bus or train being used. For non-transit legs, null." | |
| type: string | |
| "interlineWithPreviousLeg": | |
| xml: | |
| attribute: true | |
| description: "For transit legs, if the rider should stay on the vehicle as it changes route names." | |
| type: boolean | |
| "mode": | |
| xml: | |
| attribute: true | |
| description: "The mode (e.g., <code>Walk</code>) used when traversing this leg." | |
| type: string | |
| "rentedBike": | |
| xml: | |
| attribute: true | |
| type: boolean | |
| "route": | |
| xml: | |
| attribute: true | |
| 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": | |
| xml: | |
| attribute: true | |
| description: "For transit leg, the route's branding URL (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeColor": | |
| xml: | |
| attribute: true | |
| description: "For transit leg, the route's (background) color (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeLongName": | |
| xml: | |
| attribute: true | |
| type: string | |
| "routeShortName": | |
| xml: | |
| attribute: true | |
| type: string | |
| "routeTextColor": | |
| xml: | |
| attribute: true | |
| description: "For transit leg, the route's text color (if one exists). For non-transit legs, null." | |
| type: string | |
| "routeType": | |
| xml: | |
| attribute: true | |
| 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": | |
| xml: | |
| attribute: true | |
| description: "For transit legs, the service date of the trip.\nFor non-transit legs, null." | |
| type: string | |
| "tripBlockId": | |
| xml: | |
| attribute: true | |
| description: "For transit leg, the trip's block ID (if one exists). For non-transit legs, null." | |
| type: string | |
| "tripShortName": | |
| xml: | |
| attribute: true | |
| description: "For transit leg, the trip's short name (if one exists). For non-transit legs, null." | |
| type: string | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_apiAlert" | |
| "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 | |
| "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 | |
| "duration": | |
| description: "The leg's duration in seconds" | |
| type: number | |
| format: double | |
| "endTime": | |
| description: "The date and time this leg ends." | |
| type: string | |
| format: date-time | |
| "from": | |
| $ref: "#/components/schemas/xml_ns0_apiPlace" | |
| "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 | |
| "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/xml_ns0_apiPlace" | |
| "isNonExactFrequency": | |
| description: "Is this a frequency-based trip with non-strict departure times?" | |
| type: boolean | |
| "legGeometry": | |
| $ref: "#/components/schemas/xml_ns0_encodedPolylineBean" | |
| "pathway": | |
| description: "Is this leg a traversing pathways?" | |
| type: boolean | |
| "realTime": | |
| description: "Whether there is real-time data about this Leg" | |
| type: boolean | |
| "routeId": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "startTime": | |
| description: "The date and time this leg begins." | |
| type: string | |
| format: date-time | |
| "to": | |
| $ref: "#/components/schemas/xml_ns0_apiPlace" | |
| "tripId": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "walkSteps": | |
| xml: | |
| name: steps | |
| wrapped: true | |
| description: "A series of turn by turn instructions used for walking, biking and driving." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_apiWalkStep" | |
| "xml_ns0_apiPlace": | |
| title: "apiPlace" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "orig": | |
| xml: | |
| attribute: true | |
| type: string | |
| "stopIndex": | |
| xml: | |
| attribute: true | |
| description: "For transit trips, the stop index (numbered from zero from the start of the trip" | |
| type: integer | |
| format: int32 | |
| "stopSequence": | |
| xml: | |
| attribute: true | |
| description: "For transit trips, the sequence number of the stop. Per GTFS, these numbers are increasing." | |
| type: integer | |
| format: int32 | |
| "vertexType": | |
| xml: | |
| attribute: true | |
| $ref: "#/components/schemas/xml_ns0_apiVertexType" | |
| "zoneId": | |
| xml: | |
| attribute: true | |
| type: string | |
| "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 | |
| "departure": | |
| description: "The time the rider will depart the place." | |
| type: string | |
| format: date-time | |
| "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 | |
| "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" | |
| "xml_ns0_apiRelativeDirection": | |
| title: "apiRelativeDirection" | |
| 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_apiTripPlan": | |
| title: "apiTripPlan" | |
| 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_apiPlace" | |
| "itinerary": | |
| xml: | |
| name: itineraries | |
| wrapped: true | |
| description: "A list of possible itineraries. The wrapper is named 'itineraries' while the\nelements them self is named 'itinerary'." | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_apiItinerary" | |
| "to": | |
| $ref: "#/components/schemas/xml_ns0_apiPlace" | |
| "xml_ns0_apiTripSearchMetadata": | |
| title: "apiTripSearchMetadata" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "searchWindowUsed" | |
| properties: | |
| "nextDateTime": | |
| description: "This is the suggested search time for the \"next page\" or time window. Insert it together\nwith the #searchWindowUsed in the request to get a new set of trips following in the\ntime-window AFTER the current search. No duplicate trips should be returned, unless a trip\nis delayed and new realtime-data is available.\n<p>\nIf OTP for some reason is not able to calculate this value then it will be null.\n<p>\nUnit : epoch milliseconds" | |
| type: integer | |
| format: int64 | |
| "prevDateTime": | |
| description: "This is the suggested search time for the \"previous page\" or time window. Insert it together\nwith the #searchWindowUsed in the request to get a new set of trips preceding in the\ntime-window BEFORE the current search. No duplicate trips should be returned, unless a trip\nis delayed and new realtime-data is available.\n<p>\nIf OTP for some reason is not able to calculate this value then it will be null.\n<p>\nUnit : epoch milliseconds" | |
| type: integer | |
| format: int64 | |
| "searchWindowUsed": | |
| description: "This is the time window used by the raptor search. The window is an optional parameter and\nOTP might override it/dynamically assign a new value.\n<p>\nUnit : seconds" | |
| type: integer | |
| format: int32 | |
| "xml_ns0_apiVertexType": | |
| title: "apiVertexType" | |
| type: string | |
| enum: | |
| - "NORMAL" | |
| - "BIKESHARE" | |
| - "BIKEPARK" | |
| - "TRANSIT" | |
| "xml_ns0_apiWalkStep": | |
| title: "apiWalkStep" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "distance" | |
| - "lat" | |
| - "lon" | |
| properties: | |
| "absoluteDirection": | |
| $ref: "#/components/schemas/xml_ns0_apiAbsoluteDirection" | |
| "alerts": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_apiAlert" | |
| "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: string | |
| "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_apiRelativeDirection" | |
| "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: | |
| name: AlertPatchCreationResponse | |
| "xml_ns0_alertPatchResponse": | |
| title: "alertPatchResponse" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "AlertPatch": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_alertPatch" | |
| xml: | |
| name: alertPatchResponse | |
| "xml_ns0_alertPatchSet": | |
| title: "alertPatchSet" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "AlertPatch": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_alertPatch" | |
| xml: | |
| name: AlertPatchSet | |
| "xml_ns0_apiAlert": | |
| title: "apiAlert" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "alertDescriptionText": | |
| xml: | |
| attribute: true | |
| type: string | |
| "alertHeaderText": | |
| xml: | |
| attribute: true | |
| type: string | |
| "alertUrl": | |
| xml: | |
| attribute: true | |
| type: string | |
| "effectiveStartDate": | |
| type: string | |
| format: date-time | |
| xml: | |
| name: 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: | |
| "station": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_bikeRentalStation" | |
| xml: | |
| name: BikeRentalStationList | |
| "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: | |
| "layer": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_inspectorLayer" | |
| xml: | |
| name: InspectorLayersList | |
| "xml_ns0_inspectorLayer": | |
| title: "inspectorLayer" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "key": | |
| xml: | |
| attribute: true | |
| type: string | |
| "name": | |
| xml: | |
| attribute: true | |
| type: string | |
| "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" | |
| "metadata": | |
| $ref: "#/components/schemas/xml_ns0_apiTripSearchMetadata" | |
| "plan": | |
| $ref: "#/components/schemas/xml_ns0_apiTripPlan" | |
| "requestParameters": | |
| description: "A dictionary of the parameters provided in the request that triggered this response." | |
| type: object | |
| additionalProperties: | |
| type: string | |
| xml: | |
| name: response | |
| "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: | |
| name: serverInfo | |
| "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_feedScopedId": | |
| title: "feedScopedId" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "feedId": | |
| type: string | |
| "id": | |
| type: string | |
| "xml_ns0_alert": | |
| title: "alert" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "alertAdviceText": | |
| type: string | |
| format: binary | |
| "alertDescriptionText": | |
| type: string | |
| format: binary | |
| "alertDetailText": | |
| type: string | |
| format: binary | |
| "alertHeaderText": | |
| type: string | |
| format: binary | |
| "alertType": | |
| type: string | |
| "alertUrl": | |
| type: string | |
| format: binary | |
| "alertUrlList": | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/xml_ns0_alertUrl" | |
| "effectiveEndDate": | |
| type: string | |
| format: date-time | |
| "effectiveStartDate": | |
| type: string | |
| format: date-time | |
| "severity": | |
| type: string | |
| "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" | |
| "situationNumber": | |
| type: string | |
| "stop": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "trip": | |
| $ref: "#/components/schemas/xml_ns0_feedScopedId" | |
| "xml_ns0_alertUrl": | |
| title: "alertUrl" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| properties: | |
| "label": | |
| type: string | |
| "uri": | |
| type: string | |
| "xml_ns0_bikeRentalStation": | |
| title: "bikeRentalStation" | |
| allOf: | |
| - type: string | |
| format: binary | |
| - type: object | |
| required: | |
| - "allowDropoff" | |
| - "bikesAvailable" | |
| - "isCarStation" | |
| - "isFloatingBike" | |
| - "realTimeData" | |
| - "spacesAvailable" | |
| - "x" | |
| - "y" | |
| properties: | |
| "allowDropoff": | |
| xml: | |
| attribute: true | |
| type: boolean | |
| "bikesAvailable": | |
| xml: | |
| attribute: true | |
| type: integer | |
| format: int32 | |
| "id": | |
| xml: | |
| attribute: true | |
| type: string | |
| "isCarStation": | |
| xml: | |
| attribute: true | |
| type: boolean | |
| "isFloatingBike": | |
| xml: | |
| attribute: true | |
| type: boolean | |
| "name": | |
| xml: | |
| attribute: true | |
| description: "Gets translated name of bike rental station based on locale" | |
| type: string | |
| "networks": | |
| xml: | |
| attribute: true | |
| description: "List of compatible network names. Null (default) to be compatible with all." | |
| type: array | |
| items: | |
| type: string | |
| "realTimeData": | |
| xml: | |
| attribute: true | |
| 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": | |
| xml: | |
| attribute: true | |
| type: integer | |
| format: int32 | |
| "x": | |
| xml: | |
| attribute: true | |
| type: number | |
| format: double | |
| "y": | |
| xml: | |
| attribute: true | |
| 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_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_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