HERE Intermodal Routing API v8

{"openapi":"3.0.2","info":{"title":"Intermodal Routing API v8","version":"8.0.1","description":"Intermodal Routing is a REST API that offers an innovative and smart routing\nexperience in urban areas to navigate between a given pair of locations.\nThis is possible when the consolidated public transit offer is intertwined\nwith external mobility services dynamically scattered in urban areas.\n","termsOfService":"https://legal.here.com/en-gb/terms","license":{"name":"HERE Documentation License","url":"https://legal.here.com/en-gb/terms/documentation-license"}},"servers":[{"url":"https://intermodal.router.hereapi.com/v8","description":"Intermodal Routing Service"}],"security":[{"Bearer":[]},{"ApiKey":[]}],"paths":{"/routes":{"get":{"operationId":"Intermodal Routing API v8 getIntermodalRoutes","summary":"Routes","tags":["Intermodal Routing"],"description":"Lists intermodal routes.\nAll or a combination of the following services may be utilized by the\nintermodal algorithm to generate intermodal routes:\n\n* Vehicle routing.\n* Intermodal routing with real-time and timetable departures.\n* Pedestrian routing with pedestrian connectivity.\n* Park and Ride service that combines vehicle and public transit routing.\n* Real-time traffic and traffic incidents.\n* Public transit service delays/disruptions information from transit authorities.\n* Amenities available at transit stations or nearby (such as parking, EV charging stations, etc.).\n* Sharing services available at transit stations or nearby (such as car sharing, taxi, bicycle, etc.).\n","parameters":[{"$ref":"#/components/parameters/origin"},{"$ref":"#/components/parameters/destination"},{"$ref":"#/components/parameters/intermodalVia"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/units"},{"$ref":"#/components/parameters/departureTime"},{"$ref":"#/components/parameters/arrivalTime"},{"$ref":"#/components/parameters/alternatives"},{"$ref":"#/components/parameters/changes"},{"$ref":"#/components/parameters/accessibility"},{"$ref":"#/components/parameters/pedestrianSpeed"},{"$ref":"#/components/parameters/pedestrianMaxDistance"},{"$ref":"#/components/parameters/bicycleMinDistance"},{"$ref":"#/components/parameters/bicycleMaxDistance"},{"$ref":"#/components/parameters/kickScooterMinDistance"},{"$ref":"#/components/parameters/kickScooterMaxDistance"},{"$ref":"#/components/parameters/transitModes"},{"$ref":"#/components/parameters/transitEnable"},{"$ref":"#/components/parameters/vehicleModes"},{"$ref":"#/components/parameters/vehicleEnable"},{"$ref":"#/components/parameters/taxiModes"},{"$ref":"#/components/parameters/taxiEnable"},{"$ref":"#/components/parameters/rentedModes"},{"$ref":"#/components/parameters/rentedEnable"},{"$ref":"#/components/parameters/transitReturn"},{"$ref":"#/components/parameters/xRequestId"}],"responses":{"200":{"description":"API response in case of success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntermodalRouteResponse"}}},"headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}}},"400":{"$ref":"#/components/responses/400ErrorResponseWithRequestID"},"401":{"$ref":"#/components/responses/401ErrorResponseWithRequestID"},"403":{"$ref":"#/components/responses/403ErrorResponseWithRequestID"},"500":{"$ref":"#/components/responses/500ErrorResponseWithRequestID"},"502":{"$ref":"#/components/responses/502ErrorResponseWithRequestID"},"503":{"$ref":"#/components/responses/503ErrorResponseWithRequestID"},"504":{"$ref":"#/components/responses/504ErrorResponseWithRequestID"}}}},"/health":{"get":{"operationId":"Intermodal Routing API v8 getHealth","summary":"Health","tags":["API Information"],"description":"Returns the health of the service","parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[],"responses":{"200":{"$ref":"#/components/responses/HealthResponseOkWithRequestID"},"default":{"$ref":"#/components/responses/HealthResponseFailWithRequestID"}}}},"/version":{"get":{"operationId":"Intermodal Routing API v8 getVersion","summary":"Version","tags":["API Information"],"description":"Returns the version of the service","parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[],"responses":{"200":{"$ref":"#/components/responses/VersionResponseOkWithRequestID"},"500":{"$ref":"#/components/responses/500ErrorResponseWithRequestID"},"502":{"$ref":"#/components/responses/502ErrorResponseWithRequestID"},"503":{"$ref":"#/components/responses/503ErrorResponseWithRequestID"},"504":{"$ref":"#/components/responses/504ErrorResponseWithRequestID"}}}},"/openapi":{"get":{"summary":"Retrieves this API specification in OpenAPI 3 format","operationId":"Intermodal Routing API v8 getOpenapi","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"responses":{"200":{"$ref":"#/components/responses/OpenApiResponseOk"},"500":{"$ref":"#/components/responses/500ErrorResponseWithRequestID"},"502":{"$ref":"#/components/responses/502ErrorResponseWithRequestID"},"503":{"$ref":"#/components/responses/503ErrorResponseWithRequestID"},"504":{"$ref":"#/components/responses/504ErrorResponseWithRequestID"}}}}},"components":{"parameters":{"accessibility":{"name":"accessibility","description":"Defines accessibility requirements for routes.\n\n * `wheelchair` - Select only wheelchair accessible vehicles and stations.\n","in":"query","schema":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["wheelchair"]}},"style":"form","explode":false},"alternatives":{"name":"alternatives","description":"Number of alternative routes to return aside from the optimal route. By default, `alternatives=0` is assumed and only one optimal route is returned. In cases where also a pedestrian route is available it will be also returned. This may lead to two routes being returned in total (one transit route and one pedestrian route) even though only one is expected when `alternatives=0` is given.\n","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":5,"default":0}},"arrivalTime":{"name":"arrivalTime","description":"Specifies the time of arrival as defined by either `date-time` or `full-date` `T` `partial-time` in `RFC 3339`, section 5.6 (for example, `2019-06-24T01:23:45`).\nThe requested time is converted to the local time at destination. When the optional timezone offset is\nnot specified, time is assumed to be local.\nAll `Time` values in the response are returned in the timezone of each location.\n\nNote : The following features do not support the arrivalTime parameter:\n* EV Routing\n* Route Handle\n* Route Import\n","in":"query","allowReserved":true,"required":false,"schema":{"$ref":"#/components/schemas/Time"}},"bicycleMaxDistance":{"name":"bicycle[maxDistance]","description":"Maximum allowed cycling distance in meters (e.g. when looking for nearest stations).","in":"query","schema":{"type":"integer","minimum":1,"maximum":10000,"default":5000}},"bicycleMinDistance":{"name":"bicycle[minDistance]","description":"Preferred minimal cycling distance in meters (e.g. when searching for nearest stations). Unlike `bicycle[maxDistance]` this is not a requirement but a preferred value. This means that routes that are slightly shorter than the given value may still be returned. The default value is 750m if `transit[enable]` contains `entireRoute`, otherwise it is 1m.","in":"query","schema":{"type":"integer","minimum":1,"maximum":5000,"default":750}},"changes":{"name":"changes","description":"Maximum number of changes or transfers allowed in a route. Unlimited number of changes is permitted when not set.\n","in":"query","schema":{"type":"integer","minimum":0,"maximum":6}},"departureTime":{"name":"departureTime","description":"Specifies the time of departure as defined by either `date-time` or `full-date` `T` `partial-time` in `RFC 3339`, section 5.6 (for example, `2019-06-24T01:23:45`).\nThe requested time is converted to the local time at origin. When the optional timezone offset is\nnot specified, time is assumed to be local. If neither `departureTime` or `arrivalTime` are specified, current time at departure location will be used.\nAll `Time` values in the response are returned in the timezone of each location.\n","in":"query","allowReserved":true,"required":false,"schema":{"$ref":"#/components/schemas/Time"}},"destination":{"name":"destination","description":"Trip destination WGS-84 compliant coordinates.\n\nFormat: `{lat},{lng}[;placeName={name}]`\n\nThe optional `placeName` parameter can be used to customize the\n  name of the destination place and will affect the generated actions descriptions.\n\n","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LocationString"}},"intermodalVia":{"name":"via","description":"Defines an intermediate via waypoint.\n\nAt the moment via point is supported with the following syntax:\n\n`via=place:parkingLot;strategy={strategy}`: Defines the change between modes in a parking lot.\n  The optional parameter `strategy` defines the search strategy for candidate parking lots.\n  Here is a list of possible strategies:\n  * `diverseChoices` (default): Parking lots close to the origin or close to the city border\n    will be considered.\n  * `parkLate`: switch from car to public transit as soon as possible after entering the\n    destination city's limits.\n  * `parkEarly`: try to switch from car to public transit as early as possible.\n","in":"query","schema":{"type":"string"}},"kickScooterMaxDistance":{"name":"kickScooter[maxDistance]","description":"Maximum allowed travel distance in meters (e.g. when looking for nearest stations).","in":"query","schema":{"type":"integer","minimum":1,"maximum":10000,"default":5000}},"kickScooterMinDistance":{"name":"kickScooter[minDistance]","description":"Preferred minimal travel distance in meters (e.g. when searching for nearest stations). Unlike `kickScooter[maxDistance]` this is not a requirement but a preferred value. This means that routes that are slightly shorter than the given value may still be returned. The default value is 750m if `transit[enable]` contains `entireRoute`, otherwise it is 1m.","in":"query","schema":{"type":"integer","minimum":1,"maximum":5000,"default":750}},"lang":{"name":"lang","description":"Specifies the list of preferred languages of the response.\nThe first supported language from the list will be used for the response.\nThe value should comply with the [IETF BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).\n","in":"query","schema":{"type":"array","items":{"type":"string"},"default":["en-US"]},"style":"form","explode":false,"example":["zh-tw","en-gb","en-us"]},"origin":{"name":"origin","description":"Trip origin WGS-84 compliant coordinates.\n\nFormat: `{lat},{lng}[;placeName={name}]`\n\nThe optional `placeName` parameter can be used to customize\n  the name of the origin place and will affect the generated actions descriptions.\n\n","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LocationString"}},"pedestrianMaxDistance":{"name":"pedestrian[maxDistance]","description":"Maximum allowed walking distance in meters (e.g. when looking for nearest stations).","in":"query","schema":{"type":"integer","minimum":0,"maximum":6000,"default":2000}},"pedestrianSpeed":{"name":"pedestrian[speed]","description":"Walking speed in meters per second. Influences the duration of walking segments from origin to a station, from a station to destination and in-between the stations (e.g. if transfer is needed).\n","in":"query","schema":{"$ref":"#/components/schemas/PedestrianSpeed"}},"rentedEnable":{"name":"rented[enable]","description":"Route parts where the rented vehicle modes are allowed. By default, rented modes are allowed everywhere in the route.\n","in":"query","schema":{"$ref":"#/components/schemas/EnableInRouteAll"},"style":"form","explode":false},"rentedModes":{"name":"rented[modes]","description":"Modes filter used to determine which rented modes to include in the response. By default, all supported rented modes are permitted.\n","in":"query","schema":{"$ref":"#/components/schemas/RentedModesFilter"},"style":"form","explode":false},"taxiEnable":{"name":"taxi[enable]","description":"Route parts where the taxi vehicle modes are allowed. By default, taxi modes are allowed everywhere in the route.\n","in":"query","schema":{"$ref":"#/components/schemas/EnableInRouteAll"},"style":"form","explode":false},"taxiModes":{"name":"taxi[modes]","description":"Modes filter used to determine which taxi modes to include in the response. By default, all supported taxi modes are permitted.\n","in":"query","schema":{"$ref":"#/components/schemas/TaxiModesFilter"},"style":"deepObject","explode":true},"transitEnable":{"name":"transit[enable]","description":"Route parts where the transit modes are allowed. By default, transit modes are allowed everywhere in the route.\n","in":"query","schema":{"$ref":"#/components/schemas/EnableInRouteAll"},"style":"form","explode":false},"transitModes":{"name":"transit[modes]","description":"Mode filter used to determine which transit modes to include in the response. By default, all supported transit modes are permitted.\n","in":"query","schema":{"$ref":"#/components/schemas/TransitModesFilter"},"style":"form","explode":false},"transitReturn":{"name":"return","description":"Defines which section attributes are included.\n\n * `intermediate` - List of intermediate stops within a section of the route. If\n   enabled, the response includes `intermediateStops` attribute. Each intermediate stop includes\n   stop/station names, WGS-84 geocoordinates, and the departure times at the stops.\n * `fares` - List of fares/tickets to cover a section of the route.\n\n   **NOTE**: Fares information support will be available soon.\n * `polyline` - Polyline for the route in\n   [Flexible Polyline](https://github.com/heremaps/flexible-polyline/blob/master/README.md)\n   Encoding.\n * `actions` - Actions (such as maneuvers or tasks) that must be taken to complete the section.\n * `travelSummary` - Include summary for the travel portion of the section.\n * `incidents` - Include a list of all incidents applicable to each section.\n * `bookingLinks` - Include a list of links to book a ride for a section of the route.\n * `nextDepartures` - Return the next departures for the transit section.\n * `sourceFeedMapping` - Include a list of source feed data that matches the data of the section.\n * `serviceTimes` - Include service times for the transit section.\n    \n    **NOTE:** serviceTimes is an experimental feature and may not return accurate results for all routes.\n","in":"query","schema":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["intermediate","fares","polyline","actions","travelSummary","incidents","bookingLinks","nextDepartures","sourceFeedMapping","serviceTimes"]}},"style":"form","explode":false},"units":{"name":"units","description":"Units of measurement used, for example, in guidance instructions. The default is `metric`.\n\nIf `imperial` units are requested and the requested language is `en-US`, then\nUnited States customary units (miles and feet) will be used.\nIf `imperial` units are requested and a language other than `en-US` is requested then\nimperial (miles and yards) units will be used.\n","in":"query","schema":{"$ref":"#/components/schemas/Units"}},"vehicleEnable":{"name":"vehicle[enable]","description":"Route parts where the private vehicle modes are allowed. By default, vehicle modes are not allowed.\nThe combination of `car` in `vehicle[modes]` and `routeTail` in `vehicle[enable]` is not supported and is ignored. In other words, a car is not supported in route tail. All other combinations of `vehicle[modes]` and `vehicle[enable]` work as expected.\n","in":"query","schema":{"$ref":"#/components/schemas/EnableInRouteNone"},"style":"form","explode":false},"vehicleModes":{"name":"vehicle[modes]","description":"Modes filter used to determine which vehicle modes to include in the response.\n","in":"query","schema":{"$ref":"#/components/schemas/VehicleModesFilter"},"style":"form","explode":false},"xRequestId":{"name":"X-Request-ID","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","schema":{"type":"string"}}},"headers":{"X-Correlation-Id":{"description":"Auto-generated id that univocally identifies the request.","schema":{"type":"string"},"example":"4199533b-6290-41db-8d79-edf4f4019a74"},"X-Request-Id":{"description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","schema":{"type":"string"},"example":"8230d7ad-3f1c-4191-a8dd-f3c42026da89"}},"securitySchemes":{"ApiKey":{"type":"apiKey","in":"query","name":"apiKey","description":"A key generated specifically to authenticate API requests. For more information\non how to get an API key, see [Identity and Access Management Developer Guide](https://docs.here.com/identity-and-access-management/docs/readme).\n"},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\nFor more information on how to get a bearer token, see the [Identity and Access Management Developer Guide](https://docs.here.com/identity-and-access-management/docs/readme).\n"}},"schemas":{"AttributionLinkType":{"description":"Attribution link type.\n\n* `disclaimer` - Page with further legal information from the agency.\n* `tariff` - Page with information on the tariff.\n","type":"string","enum":["disclaimer","tariff"]},"AxleGroupWeight":{"type":"object","description":"Contains the maximum allowed weight for an axle-group.\n","properties":{"maxWeight":{"description":"Maximum weight of the axle-group-weight restriction, in kilograms.","type":"integer","format":"int32","minimum":0},"axleGroup":{"description":"Extensible enum: `single` `tandem` `triple` `quad` `quint` `...`  \nAxle-group associated with the restriction.\n\nPossible values are:\n\n* single\n* tandem\n* triple\n* quad\n* quint\n","type":"string","x-extensible-enum":["single","tandem","triple","quad","quint"]}}},"ChargingConnectorType":{"description":"Extensible enum: `iec62196Type1Combo` `iec62196Type2Combo` `chademo` `tesla` `saeJ3400` `gbtDc` `unknown` `...`  \nCurrently supported connector types are:\n* `iec62196Type1Combo`:  Type 1 Combo connector, commonly called \"CCS1\"\n* `iec62196Type2Combo`:  Type 2 Combo connector, commonly called \"CCS2\"\n* `chademo`: CHAdeMO connector\n* `tesla`: North American Charging Standard (NACS) connector. This connector type is deprecated. Return value used instead of `saeJ3400` when the user specifies the deprecated value `tesla` in `ev[connectorTypes]`\n* `saeJ3400`: North American Charging System (NACS) connector\n* `gbtDc`: GB/T Guobiao GB/T 20234.3 DC connector\n* `unknown`: Connector type is not known, e.g., if station is provided by user in request\n","type":"string","x-extensible-enum":["iec62196Type1Combo","iec62196Type2Combo","chademo","tesla","saeJ3400","gbtDc","unknown"]},"ChargingStationBrand":{"type":"object","description":"Information regarding the charging station brand","properties":{"name":{"description":"Charging station brand name","type":"string"},"hrn":{"description":"Charging station brand unique ID.\nIf specified in `ev[preferredBrands]` parameter\nthen it would apply preference to adding stations of the given brand.\n\n**NOTE:** As of now it is generated as a brand name hash.\n","type":"string"}}},"ChargingSupplyType":{"description":"Extensible enum: `acSingle` `acThree` `dc` `...`  \nCurrently possible values are:\n\n* `acSingle` : Single phase Alternating Current supply\n* `acThree`: Three phase Alternating Current supply\n* `dc`: Direct Current supply\n","type":"string","x-extensible-enum":["acSingle","acThree","dc"]},"Color":{"type":"string","pattern":"#[0-9A-Fa-f]{6}","example":"#FF0000"},"DataVersion":{"type":"object","description":"Version of a specific data set","properties":{"name":{"type":"string","description":"Identifies a data set, for example, a HRN, or a service specific identifier","example":"optimized-map-for-routing"},"version":{"type":"string","description":"The current version of this data set","example":"2022.346.5.48"}},"required":["name","version"]},"DepartureDelay":{"description":"The accumulated delay in seconds from the scheduled time of the event.","type":"integer"},"DeparturePlatform":{"description":"Platform name or number for the departure.","type":"string"},"DepartureStatus":{"description":"Extensible enum: `scheduled` `cancelled` `additional` `replaced` `...`  \nStatus of the departure\n\n* `scheduled`: A trip that is running as planned in the schedule.\n* `cancelled`: A trip that existed in the schedule but was removed.\n* `additional`: An extra trip that was added in addition to a running schedule, for example, to respond to sudden passenger load.\n* `replaced`: A trip that was in the schedule but is removed and replaced with `additional` trip, for example, to replace a broken vehicle or handle detour.\n","type":"string","x-extensible-enum":["scheduled","cancelled","additional","replaced"],"default":"scheduled"},"Distance":{"type":"integer","minimum":0,"description":"Distance in meters.","example":189},"Duration":{"type":"integer","description":"Duration in seconds.","example":198},"ErrorResponse":{"type":"object","description":"Response in case of error","properties":{"title":{"type":"string","description":"Human-readable error description","example":"Input data failed validation"},"status":{"type":"integer","description":"HTTP status code","example":400},"code":{"type":"string","description":"Error code.\n\nAll error codes start with \"`E60`\".\n","example":"E600101"},"cause":{"type":"string","description":"Human-readable explanation for the error","example":"The input data in question does not comply with validation rules"},"action":{"type":"string","description":"Human-readable description of the action that can be taken to correct the error","example":"Request a valid id"},"correlationId":{"type":"string","description":"Auto-generated id that univocally identifies the request","example":"4199533b-6290-41db-8d79-edf4f4019a74"}},"required":["title","status","code","cause","action","correlationId"]},"HazardousGoodsRestriction":{"description":"Extensible enum: `explosive` `gas` `flammable` `combustible` `organic` `poison` `radioactive` `corrosive` `poisonousInhalation` `harmfulToWater` `other` `...`  \nHazardous goods restrictions refer to the limitations and regulations imposed on the transportation of specific types of hazardous materials during a trip. The following categories of hazardous goods are commonly considered:\n\n* `explosive`: Materials that are capable of causing an explosion\n* `gas`: Gas (definition varies from country to country). For details, check [here](https://en.wikipedia.org/wiki/HAZMAT_Class_2_Gases)\n* `flammable`: Materials that are easily ignited and capable of catching fire.\n* `combustible`: Materials that have the potential to burn or catch fire.\n* `organic`: Materials derived from living organisms or containing carbon compounds.\n* `poison`: Substances that can cause harm or death when ingested, inhaled, or absorbed.\n* `radioactive`: Materials that emit radiation and pose potential health risks.\n* `corrosive`: Substances that can cause damage or destruction through chemical reactions.\n* `poisonousInhalation`: Materials that are toxic when inhaled.\n* `harmfulToWater`: Materials that can cause pollution or harm to water bodies.\n* `other`: Other types of hazardous materials not covered by the above categories\n","type":"string","x-extensible-enum":["explosive","gas","flammable","combustible","organic","poison","radioactive","corrosive","poisonousInhalation","harmfulToWater","other"]},"HazardousGoodsRestrictionAny":{"description":"Indicates that all hazardous goods are subject to restrictions during the trip.","type":"string","enum":["any"],"example":"any"},"LicensePlateRestrictionType":{"description":"Extensible enum: `lastCharacter` `...`  \nSpecifies the components of the vehicle license plate\nconsidered for the restriction.\n","type":"string","x-extensible-enum":["lastCharacter"]},"Location":{"description":"Location on the Earth","properties":{"lat":{"description":"Location of a point on the Earth north or south of the equator in decimal degrees.","type":"number","format":"double","example":52.531677},"lng":{"description":"Location of a place on the Earth east or west of the prime meridian in decimal degrees.","type":"number","format":"double","example":13.381777}},"example":{"lat":52.531677,"lng":13.381777},"required":["lat","lng"]},"LocationString":{"type":"string","example":"52.5251,13.3694"},"NoticeSeverity":{"description":"Describes the impact a notice has on the resource to which the notice is attached.\n* critical - The notice must not be ignored, even if the type of notice is not known to the user. Any associated resource (e.g., route section) must not be used without further evaluation.\n* info - The notice is for informative purposes, but does not affect usability of the route.\n","type":"string","enum":["critical","info"]},"ParkingLotPlaceType":{"description":"Extensible enum: `parkAndRide` `...`  \nCurrently possible values are:\n\n* `parkAndRide` - this parking lot is of type \"Park and Ride\",\n  such as it is a parking specifically designed to allow transition between car and transit.\n","type":"string","x-extensible-enum":["parkAndRide"]},"PartialTime":{"type":"string","description":"**RFC 3339**, section 5.6 as defined by `partial-time`.","pattern":"^[012]\\d:[0-5]\\d:[0-6]\\d(\\.\\d+)?$","example":"08:30:00"},"PedestrianSpeed":{"description":"Pedestrian speed in meters per second","type":"number","minimum":0.5,"maximum":2,"default":1},"Polyline":{"type":"string","description":"Line string in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) format. Coordinates are in the WGS84 coordinate system, including `Elevation` (if present).","example":"A05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e"},"RoutingZoneReference":{"description":"A reference to a routing zone in HMC.\n\nThe standard representation of a routing zone reference has the following structure:\n`{catalogHrn}:{catalogVersion}:({layerId})?:{tileId}:{zoneId}`\n\nThe individual parts are:\n* `catalogHrn`: The HERE Resource Name that identifies the source catalog of the routing zone, example: `hrn:here:data::olp-here:rib-2`\n* `catalogVersion`: The catalog version\n* `layerId` (optional): The layer inside the catalog where the routing zone is located, example: `environmental-zones`\n* `tileId`: The HERE tile key of the partition/tile where the routing zone is located in the given version of the catalog\n* `zoneId`: The identifier of the referenced routing zone within the catalog, example: `here:cm:envzone:3455277`\n\nExample of a reference to an environmental zone in standard form:\n`hrn:here:data::olp-here:rib-2:1557:environmental-zones:all:here:cm:envzone:3455277`\n\nIn order to reduce response size, routing zone references can also be provided in a compact representation.\nIn compact form, parts of a reference are replaced by placeholders, which can be resolved using the `refReplacements` dictionary in the parent section.\nThe placeholder format is ```\\$\\d+``` and needs to be surrounded by colons or string start/end. It can be captured with the following regular expression: ```(^|:)\\$\\d+(:|$)``` .\n\nExample of the aforementioned environmental zone reference in compact form: `$0:$1:3455277`\nWith the corresponding `refReplacements`:\n```\n\"refReplacements\": {\n  \"0\": \"hrn:here:data::olp-here:rib-2:1557\",\n  \"1\": \"environmental-zones:all:here:cm:envzone\"\n}\n```\n","type":"string"},"ServiceTimes":{"description":"The first and last trip time for the transit route at the stop on a given day.\nOnly present for the departure stop of a transit section.\n\n**NOTE:** serviceTimes is an experimental feature and may not return accurate results for all routes.\n","type":"object","properties":{"firstTrip":{"description":"First trip time in local time","type":"string","example":"2025-09-25T07:00:00Z"},"lastTrip":{"description":"Last trip time in local time","type":"string","example":"2025-09-25T23:45:00Z"}}},"SimpleErrorResponseSchema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error"},"error_description":{"type":"string","description":"Human-readable error description"}}},"SourceFeedMapping":{"description":"Mapping of the internal data returned in the respone to the data from the source feed.\nA `type` will only be returned if the source feed data has a match.\nEach `type` might be returned more than once in the response as the source feed may have multiple matches.\n\nCurrently possible values for `type` are:\n\n* `agencyId`: ID of the agency that provides the data which is defined in the source feed.\n* `routeId`: ID of the route that is provided in source feed.\n* `tripId`: ID of the trip that is provided in source feed.\n* `feedVersion`: Version of the feed that is defined in source feed.\n","type":"object","properties":{"type":{"type":"string","description":"Extensible enum: `agencyId` `routeId` `tripId` `feedVersion` `...`  \nType of source feed data.\n","x-extensible-enum":["agencyId","routeId","tripId","feedVersion"],"example":"tripId"},"sourceValue":{"type":"string","description":"Source value for the data defined in the `type`.","example":"1234-567"}}},"Time":{"type":"string","description":"**RFC 3339**, section 5.6 as defined by either `date-time` or `date-only` 'T' `partial-time` (ie no time-offset).","format":"date-time"},"TimeDomain":{"description":"Specifies date and time period during which the restriction applies. Value is a string in the Time\nDomain format. Time Domain is part of the GDF (Geographic Data Files) specification, which is an ISO standard.\nCurrent standard is GDF 5.1 which is [ISO 20524-1:2020](https://www.iso.org/standard/68244.html).\n\nFor a detailed description of the Time Domain specification and usage in routing services, please refer to\nthe documentation available in the [Time Domain](https://docs.here.com/routing/docs/routing-v8-time-domain-basics) page of the Developer Guide.\n","type":"string","example":"-(d1){w1}(d3){d1}"},"TimeRestrictedWeekdays":{"type":"string","enum":["mo","tu","we","th","fr","sa","su"]},"TrailerCountRange":{"type":"object","description":"Constrains the restriction to vehicles with the number of trailers within the specified range.","properties":{"from":{"description":"Inclusive minimum of trailer count.","type":"integer","format":"int32","minimum":0},"to":{"description":"Inclusive maximum of trailer count. If not set, the maximum trailer count is unbounded.","type":"integer","format":"int32","minimum":0}}},"TransitIncidentEffect":{"description":"Extensible enum: `cancelledService` `reducedService` `additionalService` `modifiedService` `delays` `detour` `stopMoved` `other` `...`  \nAn open list of possible incident effects.\nNote: Since new types are expected to appear, it is important to check for unknown types when parsing this value.\n","type":"string","x-extensible-enum":["cancelledService","reducedService","additionalService","modifiedService","delays","detour","stopMoved","other"]},"TransitIncidentType":{"description":"Extensible enum: `technicalProblem` `strike` `demonstration` `accident` `holiday` `weather` `maintenance` `construction` `policeActivity` `medicalEmergency` `other` `...`  \nAn open list of possible incident causes / types.\nNote: Since new types are expected to appear, it is important to check for unknown types when parsing this value.\n","type":"string","x-extensible-enum":["technicalProblem","strike","demonstration","accident","holiday","weather","maintenance","construction","policeActivity","medicalEmergency","other"]},"TransitModeExcluded":{"title":"Excluded modes","description":"Extensible enum: `-highSpeedTrain` `-intercityTrain` `-interRegionalTrain` `-regionalTrain` `-cityTrain` `-bus` `-ferry` `-subway` `-lightRail` `-privateBus` `-inclined` `-aerial` `-busRapid` `-monorail` `-flight` `...`  \nTransit mode to be excluded from the route\n","type":"string","x-extensible-enum":["-highSpeedTrain","-intercityTrain","-interRegionalTrain","-regionalTrain","-cityTrain","-bus","-ferry","-subway","-lightRail","-privateBus","-inclined","-aerial","-busRapid","-monorail","-flight"]},"TransitStopAttributes":{"description":"Extensible enum:

# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-intermodal-routing-v8-openapi.yml