skipRouteStop

Skips the given RouteStop. This operation is a combination of:

Note: This operation removes RoutePlanningOptions.routeLegOptions if route is EV. If not, the two RouteLegOptions around the routeStop merge into one, without RouteLegOptions.supportingPoints, and with a RouteLegOptions.routeType matching the RouteLegOptions following the routeStop.

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

Copy of target RoutePlanningOptions with the provided routeStop removed from Itinerary, if applicable, and its UUID added to the list of charging stops to be avoided.

Parameters

routeStop

RouteStop to skip.

Throws

if routeStop has sourceType value of UserDefined and its id corresponds to either Itinerary.origin or Itinerary.destination, but Itinerary.waypoints list is empty.