Routing API Developer's Guide

RouteNoteType

Route notes are used to store additional information about the route. These notes can either be related to the calculation itself (like violated routing options) or to the characteristics of the route (like entering a toll road, passing a border, etc.).

RouteNoteType defines the following elements:

Element	Description
`Type`	`RouteNoteTypeType` Type of the note. Please refer to the enumeration type `RouteNoteTypeType` for available values.
`Code`	`RouteNoteCodeType` A code that uniquely identifies the note. This code can be used to decide how to display the note (such as with a warning icon). Please refer to the enumeration type `RouteNoteCodeType` for available values.
`Text`	`xs:string` A short text describing the note. Please note that this attribute is not subject to internationalization and should therefore not be used in user displays.
`AdditionalData`	`KeyValuePairType` Container for additional data to be stored along with the note.
`CountryChangeDetails`	`CountryChangeDetailsType` Details of the country change. Provided only in case of country change notes (notes with `Code` element value set to `countryChange`).
`ZoneIds`	`xs:list` of `xs:unsignedLong` Zones where a zone restriction is violated or is potentially violated. Provided only in case of zone restriction notes (notes with `Code` element value set to `zoneRestriction`). See Zone Restriction Notes section below for examples.

Zone Restriction Notes

The zone restriction notes are related to the Restriction elements of the RoutingZoneType. The violated zone restrictions produce route and maneuver notes in the response. The potentially violated zone restrictions produce only maneuver notes.

Note: The Note elements in the response may need to be explicitly enabled through routeAttributes and maneuverAttributes parameters (see RouteRepresentationOptionsType for details).

A route note for a violated zone restriction:

<Route>
  ...
  <Note>
    <Type>violation</Type>
    <Code>routingOptionViolated</Code>
    <Text>zoneRestriction</Text>
  </Note>
</Route>

A maneuver note for a violated zone restriction:

<Maneuver ... xsi:type="rtc:PrivateTransportManeuverType">
  ...
  <Note>
    <Type>violation</Type>
    <Code>zoneRestriction</Code>
    <ZoneIds>zoneId,...</ZoneIds> <!-- zones where zone restrictions are violated -->
  </Note>
</Maneuver>

A maneuver note for a potentially violated zone restriction:

<Maneuver ... xsi:type="rtc:PrivateTransportManeuverType">
  ...
  <Note>
    <Type>restriction</Type>
    <Code>zoneRestriction</Code>
    <ZoneIds>zoneId,...</ZoneIds> <!-- zones where zone restrictions are potentially violated -->
  </Note>
</Maneuver>