Record

get-route-params

No description available.

record get-route-params {
  point: list​<string>,
  point-hint: option​<list​<string>>,
  snap-prevention: option​<list​<string>>,
  vehicle: option​<vehicle-profile-id>,
  curbside: option​<list​<get-route-curbside-item-enum>>,
  turn-costs: option​<bool>,
  locale: option​<string>,
  elevation: option​<bool>,
  details: option​<list​<string>>,
  optimize: option​<string>,
  instructions: option​<bool>,
  calc-points: option​<bool>,
  debug: option​<bool>,
  points-encoded: option​<bool>,
  ch-disable: option​<bool>,
  weighting: option​<string>,
  heading: option​<list​<s32>>,
  heading-penalty: option​<s32>,
  pass-through: option​<bool>,
  block-area: option​<string>,
  avoid: option​<string>,
  algorithm: option​<get-route-algorithm-enum>,
  round-trip-distance: option​<s32>,
  round-trip-seed: option​<s64>,
  alternative-route-max-paths: option​<s32>,
  alternative-route-max-weight-factor: option​<f64>,
  alternative-route-max-share-factor: option​<f64>,
}

Fields

NameTypeDescription
pointlist​<string>
point-hintoption​<list​<string>>
snap-preventionoption​<list​<string>>
vehicleoption​<vehicle-profile-id>
curbsideoption​<list​<get-route-curbside-item-enum>>
turn-costsoption​<bool>
localeoption​<string>
elevationoption​<bool>
detailsoption​<list​<string>>
optimizeoption​<string>
instructionsoption​<bool>
calc-pointsoption​<bool>
debugoption​<bool>
points-encodedoption​<bool>
ch-disableoption​<bool>
weightingoption​<string>
headingoption​<list​<s32>>
heading-penaltyoption​<s32>
pass-throughoption​<bool>
block-areaoption​<string>
avoidoption​<string>
algorithmoption​<get-route-algorithm-enum>
round-trip-distanceoption​<s32>
round-trip-seedoption​<s64>
alternative-route-max-pathsoption​<s32>
alternative-route-max-weight-factoroption​<f64>
alternative-route-max-share-factoroption​<f64>