Share via

RouteSectionOutput interface

  • Reference
Package:
@azure-rest/maps-route

Route sections contain additional information about parts of a route. Each section contains at least the elements startPointIndex, endPointIndex, and sectionType.

Properties

delayInSeconds

Delay in seconds caused by the incident.
effectiveSpeedInKmh

Effective speed of the incident in km/h, averaged over its entire length.
endPointIndex

Index of the last point (offset 0) in the route this section applies to.
magnitudeOfDelay

The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the Get Traffic Incident Detail API.
sectionType

Section types of the reported route response
simpleCategory

Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See "tec" for detailed information.
startPointIndex

Index of the first point (offset 0) in the route this section applies to.
tec

Details of the traffic event, using definitions in the TPEG2-TEC standard. Can contain effectCode and causes elements.
travelMode

Travel mode for the calculated route. The value will be set to other if the requested mode of transport is not possible in this section

Property Details

delayInSeconds

Delay in seconds caused by the incident.

delayInSeconds?: number

Property Value

number

effectiveSpeedInKmh

Effective speed of the incident in km/h, averaged over its entire length.

effectiveSpeedInKmh?: number

Property Value

number

endPointIndex

Index of the last point (offset 0) in the route this section applies to.

endPointIndex: number

Property Value

number

magnitudeOfDelay

The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the Get Traffic Incident Detail API.

magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4"

Property Value

"0" | "1" | "2" | "3" | "4"

sectionType

Section types of the reported route response

sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN"

Property Value

"CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN"

simpleCategory

Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See "tec" for detailed information.

simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER"

Property Value

"JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER"

startPointIndex

Index of the first point (offset 0) in the route this section applies to.

startPointIndex: number

Property Value

number

tec

Details of the traffic event, using definitions in the TPEG2-TEC standard. Can contain effectCode and causes elements.

tec?: RouteSectionTecOutput

Property Value

RouteSectionTecOutput

travelMode

Travel mode for the calculated route. The value will be set to other if the requested mode of transport is not possible in this section

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "other"

Property Value

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "other"