Packages

class RoutingApi extends LookupScalaApi

Linear Supertypes
LookupScalaApi, ScalaApi, Api, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RoutingApi
  2. LookupScalaApi
  3. ScalaApi
  4. Api
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RoutingApi(executor: ApiRequestExecutor, apiConfiguration: ApiConfiguration, commonSettings: CommonSettings)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def getRoutes(origin: String, destination: String, lang: Seq[String] = Nil, units: Option[String] = None, departureTime: Option[OffsetDateTime] = None, arrivalTime: Option[OffsetDateTime] = None, alternatives: Option[Int] = None, changes: Option[Int] = None, modes: Seq[String] = Nil, pedestrianLeft_Square_BracketspeedRight_Square_Bracket: Option[Double] = None, pedestrianLeft_Square_BracketmaxDistanceRight_Square_Bracket: Option[Int] = None, accessibility: Seq[String] = Nil, return: Seq[String] = Nil, xRequestID: Option[String] = None): ApiRequest[TransitRouteResponse]

    Lists public transit routes.

    Lists public transit routes. The service supports several use cases as follows: * define routes based on arrival or departure times. * filter specific transit modes, such as rail and metro only. * plan routes hours or days in advance. * set a maximum distance for the walk to the nearest transit stop/station or the speed of the walk. * define how many changes or transfers the journey may include. * request turn-by-turn navigation. * request route polyline in order to view the route over a map.

    Path: /routes

    Method: GET

    Expected answers:

    code 200 : TransitRouteResponse (API response in case of success) Headers : X-Correlation-Id - X-Request-Id -

    code 400 : ErrorResponse (API response in case of bad request.) Headers : X-Correlation-Id - X-Request-Id -

    code 401 : AuthErrorResponseSchema (API response in case of unauthorized access.) Headers : X-Correlation-Id - X-Request-Id -

    code 403 : AuthErrorResponseSchema (API response in case of forbidden access.) Headers : X-Correlation-Id - X-Request-Id -

    code 500 : ErrorResponse (API response in case of internal server error.) Headers : X-Correlation-Id - X-Request-Id -

    code 502 : ErrorResponse (API response in case of bad gateway.) Headers : X-Correlation-Id - X-Request-Id -

    code 503 : ErrorResponse (API response in case of service unavailable.) Headers : X-Correlation-Id - X-Request-Id -

    code 504 : ErrorResponse (API response in case of gateway timeout.) Headers : X-Correlation-Id - X-Request-Id -

    origin

    Trip origin WGS-84 compliant coordinates. Format: {lat},{lng}[;placeName={name}] The optional placeName parameter can be used to customize the name of the origin place and will affect the generated actions descriptions.

    destination

    Trip destination WGS-84 compliant coordinates. Format: {lat},{lng}[;placeName={name}] The optional placeName parameter can be used to customize the name of the destination place and will affect the generated actions descriptions.

    lang

    Specifies the list of preferred languages of the response. The first supported language from the list will be used for for the response. The value should comply with the [IETF BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).

    units

    Units of measurement used, for example, in guidance instructions. The default is metric. If imperial units are requested and the requested language is en-US, then United States customary units (miles and feet) will be used. If imperial units are requested and a language other than en-US is requested then imperial (miles and yards) units will be used.

    departureTime

    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). The requested time is converted to the local time at origin. When the optional timezone offset is not specified, time is assumed to be local. If neither departureTime or arrivalTime are specified, current time at departure location will be used. All Time values in the response are returned in the timezone of each location.

    arrivalTime

    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). The requested time is converted to the local time at destination. When the optional timezone offset is not specified, time is assumed to be local. All Time values in the response are returned in the timezone of each location. Note : The following features do not support the arrivalTime parameter: * EV Routing * Route Handle * Route Import

    alternatives

    Number of alternative routes to return aside from the optimal route.

    changes

    Maximum number of changes or transfers allowed in a route. Unlimited number of changes is permitted when not set.

    modes

    Transit mode filter used to determine which modes of transit to include in the response. By default, all supported transit modes are permitted. Supported modes: highSpeedTrain intercityTrain interRegionalTrain regionalTrain cityTrain bus ferry subway lightRail privateBus inclined aerial busRapid monorail flight spaceship This parameter also support an exclusion list: It's sufficient to specify each mode to exclude by prefixing it with -. Mixing of inclusive and exclusive transit modes is not allowed. examples: * subway,bus. Returns only subways and busses. * -subway,-bus. Returns all modes except subways and busses.

    pedestrianLeft_Square_BracketspeedRight_Square_Bracket

    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).

    pedestrianLeft_Square_BracketmaxDistanceRight_Square_Bracket

    Maximum allowed walking distance in meters (e.g. when looking for nearest stations).

    accessibility

    Defines accessibility requirements for routes. * wheelchair - Select only wheelchair accessible vehicles and stations.

    xRequestID

    User-provided token that can be used to trace a request or a group of requests sent to the service.

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def withConfig(apiConfig: ApiConfiguration): RoutingApi

Inherited from LookupScalaApi

Inherited from ScalaApi

Inherited from Api

Inherited from AnyRef

Inherited from Any

Ungrouped