Packages

class RealTimeTrafficApi extends LookupScalaApi

Linear Supertypes
LookupScalaApi, ScalaApi, Api, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RealTimeTrafficApi
  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 RealTimeTrafficApi(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 getFlow(in: String, locationReferencing: Seq[String] = Nil, minJamFactor: Option[Double] = None, maxJamFactor: Option[Double] = None, functionalClasses: Seq[Int] = Nil, advancedFeatures: Seq[String] = Nil, xRequestId: Option[String] = None): ApiRequest[FlowResponse]

    Get real-time traffic flow data for a geospatial area.

    Get real-time traffic flow data for a geospatial area.

    Path: /flow

    Method: GET

    Expected answers:

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

    code 400 : ErrorResponse (Failure to parse the request, caused by, for example, invalid parameter values such as in=planet:mars. ) Headers : X-Correlation-Id - X-Request-Id -

    code 401 : AuthError (Authentication Failed ) Headers : X-Correlation-Id - X-Request-Id -

    code 403 : AuthError (Not allowed, such as trying to request fields without having the necessary permissions. ) Headers : X-Correlation-Id - X-Request-Id -

    code 414 : ErrorResponse (API response in case of too long uri.) Headers : X-Correlation-Id - X-Request-Id -

    code 500 : ErrorResponse (Internal server error.) Headers : X-Correlation-Id - X-Request-Id -

    code 503 : ErrorResponse (Service unavailable.) Headers : X-Correlation-Id - X-Request-Id -

    in

    Return flow items within a geographical area. Area within which to return flow. A geographic area can be one of the following: * A circular area, provided as latitude, longitude, and radius (in meters) Format: circle:{latitude},{longitude};r={radius} Type: circle:{decimal},{decimal};r={integer} Example: circle:13.1,-43.1;r=10000 * A bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_ Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude} Example: bbox:13.08836,52.33812,13.761,52.6755 * A corridor, provided as a polyline in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoding and a radius/width (in meters). The radius is measured perpendicular to each segment of the polyline on both sides, so a radius of 50 meters will cover an area 50 meters on either side of the polyline and be 100 meters wide from one side to the other. Format: corridor:{polyline};r={radius} Example: corridor:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e;r=50

    locationReferencing

    The location referencing scheme (or schemes) to be used in the response. Multiple location referencing schemes can be specified separated by commas (,). |Location Referencing | Description | |------------------|-------------| | none | The response will not contain any location references such as tmc, olr, or shape points. | | olr | Open Location References is a TISA location referencing standard also called TPEGOpenLR. Please visit https://tisa.org/ for more details. TISA Specifications are also published by ISO https://www.iso.org/ Specifications: ISO/TS 21219-22:2017 | | shape | Shape points. Defines a location by a series of geo-coordinates. | | tmc | Traffic Message Channel (TMC) location referencing method uses tables of pre-coded locations. For details please refer ISO specifications ISO 14819-3:2013 and ISO 14819-2:2013. |

    minJamFactor

    The minimum jam factor value for flow items to be included in the response. All flow items with a _lower_ jam factor than the value specified by the minJamFactor parameter are omitted. The parameter can be used by clients that require flow data for congested roadways only. The value must be in the range 0.0 to 10.0 (inclusive). Default: 0.0

    maxJamFactor

    The maximum jam factor value for flow items to be included in the response. All flow items with a _higher_ jam factor than the value specified by the maxJamFactor parameter are omitted. This parameter can be used by clients that require flow data only for congestion-free roads. The values must be in the range 0.0 to 10.0 (inclusive). Default: 1.0

    functionalClasses

    A list of functional classes separated by commas (,), to return results for. The functional class is used to group roads depending on the speed, importance, and connectivity. Functional classes are integers from 1 to 5 inclusive where functional class 1 are the most important and functional class 5 are the least important. The table below describes the roads that fall into each class. | Functional Class | Description | |------------------|-------------| | 1 | These roads are meant for high volume, maximum speed traffic between and through major metropolitan areas. There are very few, if any, speed changes. Access to this road is usually controlled. | | 2 | These roads are used to channel traffic to Main Roads (functionalClass=1) for travel between and through cities in the shortest amount of time. There are very few, if any speed changes. | | 3 | These roads interconnect First Class Roads (2) and provide a high volume of traffic movement at a lower level of mobility than First Class Roads (2). | | 4 | These roads provide for a high volume of traffic movement at moderate speeds between neighborhoods. These roads connect with higher Functional Class roads to collect and distribute traffic between neighborhoods. | | 5 | These roads' volume and traffic movements are below the level of any other road. |

    advancedFeatures

    A list of advanced features separated by commas (,), to return results for. | Feature | Description | |----------------|-------------| | deepCoverage | More complete flow coverage | | lanes | Lane level traffic information about lanes designated for High Occupancy Vehicles or at highway forks/splits | **NOTE:** Advanced features are billed at a separate price point to normal requests. Please contact HERE sales for further details.

    xRequestId

    User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

  11. def getIncidents(in: String, locationReferencing: Seq[String] = Nil, functionalClasses: Seq[Int] = Nil, criticality: Seq[String] = Nil, type: Option[String] = None, earliestStartTime: Option[OffsetDateTime] = None, latestEndTime: Option[OffsetDateTime] = None, lang: Option[String] = None, units: Option[String] = None, xRequestId: Option[String] = None): ApiRequest[IncidentsResponse]

    Get traffic incidents for a geospatial area.

    Get traffic incidents for a geospatial area.

    Path: /incidents

    Method: GET

    Expected answers:

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

    code 400 : ErrorResponse (Failure to parse the request, caused by, for example, invalid parameter values such as in=planet:mars. ) Headers : X-Correlation-Id - X-Request-Id -

    code 401 : AuthError (Authentication Failed ) Headers : X-Correlation-Id - X-Request-Id -

    code 403 : AuthError (Not allowed, such as trying to request fields without having the necessary permissions. ) Headers : X-Correlation-Id - X-Request-Id -

    code 414 : ErrorResponse (API response in case of too long uri.) Headers : X-Correlation-Id - X-Request-Id -

    code 500 : ErrorResponse (Internal server error.) Headers : X-Correlation-Id - X-Request-Id -

    code 503 : ErrorResponse (Service unavailable.) Headers : X-Correlation-Id - X-Request-Id -

    in

    Return flow items within a geographical area. Area within which to return flow. A geographic area can be one of the following: * A circular area, provided as latitude, longitude, and radius (in meters) Format: circle:{latitude},{longitude};r={radius} Type: circle:{decimal},{decimal};r={integer} Example: circle:13.1,-43.1;r=10000 * A bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_ Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude} Example: bbox:13.08836,52.33812,13.761,52.6755 * A corridor, provided as a polyline in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoding and a radius/width (in meters). The radius is measured perpendicular to each segment of the polyline on both sides, so a radius of 50 meters will cover an area 50 meters on either side of the polyline and be 100 meters wide from one side to the other. Format: corridor:{polyline};r={radius} Example: corridor:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e;r=50

    locationReferencing

    The location referencing scheme (or schemes) to be used in the response. Multiple location referencing schemes can be specified separated by commas (,). |Location Referencing | Description | |------------------|-------------| | none | The response will not contain any location references such as tmc, olr, or shape points. | | olr | Open Location References is a TISA location referencing standard also called TPEGOpenLR. Please visit https://tisa.org/ for more details. TISA Specifications are also published by ISO https://www.iso.org/ Specifications: ISO/TS 21219-22:2017 | | shape | Shape points. Defines a location by a series of geo-coordinates. | | tmc | Traffic Message Channel (TMC) location referencing method uses tables of pre-coded locations. For details please refer ISO specifications ISO 14819-3:2013 and ISO 14819-2:2013. |

    functionalClasses

    A list of functional classes separated by commas (,), to return results for. The functional class is used to group roads depending on the speed, importance, and connectivity. Functional classes are integers from 1 to 5 inclusive where functional class 1 are the most important and functional class 5 are the least important. The table below describes the roads that fall into each class. | Functional Class | Description | |------------------|-------------| | 1 | These roads are meant for high volume, maximum speed traffic between and through major metropolitan areas. There are very few, if any, speed changes. Access to this road is usually controlled. | | 2 | These roads are used to channel traffic to Main Roads (functionalClass=1) for travel between and through cities in the shortest amount of time. There are very few, if any speed changes. | | 3 | These roads interconnect First Class Roads (2) and provide a high volume of traffic movement at a lower level of mobility than First Class Roads (2). | | 4 | These roads provide for a high volume of traffic movement at moderate speeds between neighborhoods. These roads connect with higher Functional Class roads to collect and distribute traffic between neighborhoods. | | 5 | These roads' volume and traffic movements are below the level of any other road. |

    criticality

    The severity of the incident that has occured, with the following possible values: low (least severe), minor, major, and critical (most severe). A list of criticality values separated by commas (,), to return results for.

    earliestStartTime

    The earliest start time that is accepted for an incident to be included in the results. Format is **RFC 3339**, section 5.6 as defined by date-time. Will always be UTC time.

    latestEndTime

    The latest end time that is accepted for an incident to be included in the results. Format is **RFC 3339**, section 5.6 as defined by date-time. Will always be UTC time.

    lang

    The language to be used for the incident descriptions. Parameter value must follow specification: BCP47. Supported values are available on [iana.org](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)

    units

    Units of measurement to be used in incident descriptions. The default is metric.

    xRequestId

    User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

  12. def getIncidentsById(originalId: String, locationReferencing: Seq[String] = Nil, lang: Option[String] = None, units: Option[String] = None, xRequestId: Option[String] = None): ApiRequest[IncidentItem]

    Get traffic incident for a given id.

    Get traffic incident for a given id. The id can be prefixed with a namespace. If no namespace is specified, the default namespace is \"here:traffic:incident\".

    Path: /incidents/{originalId}

    Method: GET

    Expected answers:

    code 200 : IncidentItem (Incident item response for specified original id) Headers : X-Correlation-Id - X-Request-Id -

    code 400 : ErrorResponse (Failure to parse the request, it may have invalid incident id or query parameters. ) Headers : X-Correlation-Id - X-Request-Id -

    code 401 : AuthError (Authentication Failed ) Headers : X-Correlation-Id - X-Request-Id -

    code 403 : AuthError (Not allowed, such as trying to request fields without having the necessary permissions. ) Headers : X-Correlation-Id - X-Request-Id -

    code 404 : ErrorResponse (Failure to parse the request, caused by, for example, invalid parameter values such as in=planet:mars. ) Headers : X-Correlation-Id - X-Request-Id -

    code 414 : ErrorResponse (API response in case of too long uri.) Headers : X-Correlation-Id - X-Request-Id -

    code 500 : ErrorResponse (Internal server error.) Headers : X-Correlation-Id - X-Request-Id -

    code 503 : ErrorResponse (Service unavailable.) Headers : X-Correlation-Id - X-Request-Id -

    originalId

    Identifier of the first traffic incident in a chain of updates. Once an incident chain has been created, this value will never change.

    locationReferencing

    The location referencing scheme (or schemes) to be used in the response. Multiple location referencing schemes can be specified separated by commas (,). |Location Referencing | Description | |------------------|-------------| | none | The response will not contain any location references such as tmc, olr, or shape points. | | olr | Open Location References is a TISA location referencing standard also called TPEGOpenLR. Please visit https://tisa.org/ for more details. TISA Specifications are also published by ISO https://www.iso.org/ Specifications: ISO/TS 21219-22:2017 | | shape | Shape points. Defines a location by a series of geo-coordinates. | | tmc | Traffic Message Channel (TMC) location referencing method uses tables of pre-coded locations. For details please refer ISO specifications ISO 14819-3:2013 and ISO 14819-2:2013. |

    lang

    The language to be used for the incident descriptions. Parameter value must follow specification: BCP47. Supported values are available on [iana.org](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)

    units

    Units of measurement to be used in incident descriptions. The default is metric.

    xRequestId

    User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

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

Inherited from LookupScalaApi

Inherited from ScalaApi

Inherited from Api

Inherited from AnyRef

Inherited from Any

Ungrouped