您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Route - Get Route Directions

适用于: S0 和 S1 定价层。

返回源和目标之间的路由(如果指定了 waypoints)。 该路线将考虑当前流量和一周中请求日期和时间的典型路上等因素。

返回的信息包括距离、估计旅行时间和工艺路线几何的表示形式。 根据所选的选项,还可以使用其他路由信息,如优化的 waypoint 顺序或轮流打开说明。

路由服务提供了一组用于特定于车辆的消耗模型详细说明的参数。 有关所涉及的概念和参数的详细说明,请查看消耗模型

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/directions/{format}?subscription-key={subscription-key}&api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report={report}&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI 参数

Name In Required Type Description
format
path True

所需的响应格式。 值可以是_json_或_xml_。

api-version
query True
  • string

Azure Maps API 的版本号。 当前版本为1。0

query
query True
  • string

用于计算路由的坐标,由冒号分隔。 至少需要两个坐标。 第一个是原点,最后一个是路由的目标。 内的可选坐标在路由中充当 WayPoints。 最多可以传递 150 WayPoints。

accelerationEfficiency
query
  • number
float

指定当车辆加速时 _(即 KineticEnergyGained/ChemicalEnergyConsumed),将燃油中存储的化学能量转换为 kinetic 能量的效率。ChemicalEnergyConsumed_是通过使用fuelEnergyDensityInMJoulesPerLiter将消耗燃料转换为化学能量获得的。

必须与decelerationEfficiency成对出现。

允许的值的范围为0.0 到 1/decelerationEfficiency

合理值:对于Combustion 型号为0.33,对于电气型号为:0.66

alternativeType
query

根据给定的规划条件,控制与引用路由相比计算的替代项的最优性。

arriveAt
query
  • string
date-time

到达目标点时的日期和时间。 它必须指定为日期时间。 如果未指定时区偏移量,则假定它是目标点的偏移量。 ArriveAt 值必须为将来的值。 ArriveAt 参数不能与 departAt、minDeviationDistance 或 minDeviationTime 结合使用。

auxiliaryPowerInkW
query
  • string

指定维持辅助系统的电量使用量,以千瓦(kW)表示。

它可用于指定设备和系统(如 AC 系统、无线电、加热等)的消耗。

合理值:1。7

auxiliaryPowerInLitersPerHour
query
  • number
float

指定维持在车辆的辅助系统上使用的燃料量,单位为每小时升。

它可用于指定设备和系统(如 AC 系统、无线电、加热等)的消耗。

合理值:0。2

avoid
query

指定路由计算在确定路由时应尽量避免的内容。 可以在一个请求中多次指定,例如 "&避免 = motorways&避免 = tollRoads&避免 = ferries"。 在 calculateReachableRange 请求中,不能使用 alreadyUsedRoads 值。

computeBestOrder
query
  • boolean

使用快速启发式算法重新排序路由 waypoints,以减少路由长度。 与 routeType_最短_结合使用时,产生最佳结果。 请注意,源和目标将从优化的 waypoint 索引中排除。 若要在响应中包含源和目标,请将所有索引按1增加到源的帐户,然后将目标添加为最终索引。 可能值为 true 或 false。 如果可能,则 True 计算更好的顺序,但不允许与大于0的 maxAlternatives 值或与 circle waypoints 结合使用。 False 将使用给定顺序的位置,而不允许将其与 routeRepresentation _none_结合使用。

computeTravelTimeFor
query

指定是否使用不同类型的流量信息(无、历史、实时)以及默认的最佳估计行程时间来返回额外的行程时间。

constantSpeedConsumptionInkWhPerHundredkm
query
  • string

指定消耗的速度依赖的组件。

作为速度/消耗率对的无序列表提供。 该列表定义了消耗曲线上的点。 列表中未列出的速度的消耗费率如下所示:

  • 通过线性内插,如果给定速度在列表中的两个速度之间,

  • 通过线性外推,假设由列表中最接近的两个点确定的常量(ΔConsumption/ΔSpeed)

此列表必须包含1到25个点(含),并且可能不包含相同速度的重复点。 如果它只包含一个点,则使用该点的消耗率,而不进行进一步处理。

为最大速度指定的使用量必须大于或等于倒数第二的最大速度。 这可确保推断不会导致负消耗率。

同样,为列表中的两个最小速率指定的消耗值不会导致任何更小速度的负消耗率。

消耗值(以 kWh/100km 表示)的有效范围介于0.01 和100000.0 之间。

合理值:50,8.2:130,21。3

对于电气消耗模型,此参数是必需的。

constantSpeedConsumptionInLitersPerHundredkm
query
  • number
float

指定消耗的速度依赖的组件。

作为以冒号分隔的速度的无序列表的形式提供 & 消耗率对。 该列表定义了消耗曲线上的点。 列表中未列出的速度的消耗费率如下所示:

  • 通过线性内插,如果给定速度在列表中的两个速度之间,

  • 通过线性外推,假设由列表中最接近的两个点确定的常量(ΔConsumption/ΔSpeed)

此列表必须包含1到25个点(含),并且可能不包含相同速度的重复点。 如果它只包含一个点,则使用该点的消耗率,而不进行进一步处理。

为最大速度指定的使用量必须大于或等于倒数第二的最大速度。 这可确保推断不会导致负消耗率。

同样,为列表中的两个最小速率指定的消耗值不会导致任何更小速度的负消耗率。

消耗值(以 l/100km 表示)的有效范围介于0.01 和100000.0 之间。

合理值:50,6.3:130,11。5

注意:此参数对于Combustion 消耗模型是必需的。

currentChargeInkWh
query
  • string

指定当前电设备的电流单位(kWh)。

此参数与maxChargeInkWh参数并存。

允许的值的范围为0.0 到maxChargeInkWh

合理值:43

currentFuelInLiters
query
  • number
float

指定燃油的当前供应。

合理值:55

decelerationEfficiency
query
  • number
float

指定在车辆减速 _(即 ChemicalEnergySaved/KineticEnergyLost)时,将 kinetic 能量转换为已保存(未使用)燃料的效率。ChemicalEnergySaved_是通过使用fuelEnergyDensityInMJoulesPerLiter将已保存(未使用)燃料转换为能量来获取的。

必须与accelerationEfficiency成对出现。

允许的值的范围为0.0 到 1/accelerationEfficiency

合理值:对于Combustion 型号为0.83,对于电气型号为:0.91

departAt
query
  • string
date-time

从原点开始的日期和时间。 现在,必须将出发时间指定为日期时间。 如果未指定时区偏移量,则假定其为原点。 DepartAt 值必须采用日期时间格式(1996-12-19T16:39: 57-08:00)。

downhillEfficiency
query
  • number
float

指定当车辆失去提升 _(即 ChemicalEnergySaved/PotentialEnergyLost)时,将可能的能量转换为已保存(未使用)燃料的效率。ChemicalEnergySaved_是通过使用fuelEnergyDensityInMJoulesPerLiter将已保存(未使用)燃料转换为能量来获取的。

必须与uphillEfficiency成对出现。

允许的值的范围为0.0 到 1/uphillEfficiency

合理值:对于Combustion 型号为0.51,对于电气型号为:0.73

fuelEnergyDensityInMJoulesPerLiter
query
  • number
float

指定以 megajoules (MJ)一升一升的化学能量量。 它与 *高效性参数一起用于保存或消耗的能源与燃料之间的转换。 例如,能源密度为汽油为34.2,柴油燃料为 35.8 MJ/l。

如果设置了任何 *高效性参数,则此参数是必需的。

合理值:34。2

hilliness
query

Thrilling 路由的 hilliness 度。 此参数只能与 routeType = thrilling 一起使用。

instructionsType
query

如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation = none 一起使用

language
query
  • string

Language 参数确定指导消息的语言。 它不会影响正确名词(街道名称、plazas 等名称)它在 instructionsType = 编码时不起作用。 允许的值为所述的 IETF 语言标记的(子集)

maxAlternatives
query
  • integer

需要计算的备用路由数。 默认值:0,最小值:0,最大值:5

maxChargeInkWh
query
  • string

指定可存储在车辆电池中的最大电力电量,单位为千瓦时小时(kWh)。

此参数与currentChargeInkWh参数并存。

最小值必须大于或等于currentChargeInkWh

合理值:85

minDeviationDistance
query
  • integer

返回的所有备用路由都将遵循 calculateRoute 请求的源点中的引用路由(请参阅 "POST 请求" 部分),此时间间隔为至少。 仅可在重新构造路由时使用。 MinDeviationDistance 参数不能与 arriveAt 一起使用。

minDeviationTime
query
  • integer

返回的所有备用路由都将遵循 calculateRoute 请求的源点中的引用路由(参见 "POST 请求" 一节),至少在此秒数内。 仅可在重新构造路由时使用。 MinDeviationTime 参数不能与 arriveAt 一起使用。 默认值为 0。 设置) minDeviationTime_ 设置为大于零的值将产生以下结果:

  • _CalculateRoute_请求的源点必须位于输入引用路由上(或非常接近)。
    • 如果不是这种情况,则会返回错误。
    • 但是,原点不需要位于输入引用路由的开头(可以被视为引用路由上的当前车辆位置)。
  • 作为_calculateRoute_响应中的第一个路由返回的引用路由将从_calculateRoute_请求中指定的原始点开始。 输入引用路由的初始部分将从响应中排除原点。
  • _MinDeviationDistance_和_minDeviationTime_的值确定哪些备用路由将保证从原始点向上跟随引用路由。
  • 路由必须使用_departAt_。
  • 将忽略_vehicleHeading_ 。
report
query
  • string

指定出于诊断目的应报告的数据。 唯一的可能值为_effectiveSettings_。 报告调用 API 时使用的有效参数或数据。 对于默认参数,默认值将反映调用方未指定参数的位置。

routeRepresentation
query

指定作为响应提供的路由集的表示形式。 此参数值仅可与 computeBestOrder = true 一起使用。

routeType
query

请求的路由类型。

sectionType
query

指定在路由响应中报告的部分类型。

例如,如果 sectionType = 行人,则将返回仅适用于 pedestrians 的部分。 可以使用多个类型。 默认的 sectionType 是指 travelMode 输入。 默认情况下,travelMode 设置为 car

subscription-key
query
  • string

从 Azure 地图帐户提供的 Azure Maps 密钥之一。 有关如何管理身份验证的详细信息,请参阅此

traffic
query
  • boolean

可能的值:

  • true-在路由过程中考虑所有可用的流量信息
  • false-在路由过程中忽略当前流量数据。 请注意,尽管在路由过程中会忽略当前流量数据,但仍会合并历史流量对有效道路速度产生的影响。
travelMode
query

请求的路由的旅行模式。 如果未定义,则默认值为 "car"。 请注意,请求的 travelMode 可能不可用于整个路由。 如果请求的 travelMode 不可用于特定部分,则该部分的响应的 travelMode 元素将是 "其他"。 请注意,旅行模式总线、摩托车、出租车和 van 都是 BETA 版功能。 完全限制数据在所有区域中都不可用。 在calculateReachableRange请求中,不得使用值 "自行车" 和 "行人"。

uphillEfficiency
query
  • number
float

指定当车辆获得提升 _(即 PotentialEnergyGained/ChemicalEnergyConsumed)时,将燃油中存储的化学能量转换为潜在能量的效率。ChemicalEnergyConsumed_是通过使用fuelEnergyDensityInMJoulesPerLiter将消耗燃料转换为化学能量获得的。

必须与downhillEfficiency成对出现。

允许的值的范围为0.0 到 1/downhillEfficiency

合理值:对于Combustion 型号为0.27,对于电气型号为:0.74

vehicleAxleWeight
query
  • integer

车辆的每个 axle 的重量(千克)。 值0表示不考虑每个 axle 的权重限制。

vehicleCommercial
query
  • boolean

车辆用于商业目的,因此可能不允许在某些道路上推动。

vehicleEngineType
query

车辆的引擎类型。 指定详细的消耗模型时,它必须与vehicleEngineType的值保持一致。

vehicleHeading
query
  • integer

汽车的方向标题,以度为单位从 true 开始,以顺时针方向继续。 北为0度,东为90度,南部为180度,西部为270度。 可能值0-359

vehicleHeight
query
  • number
float

车辆的高度(以米为单位)。 值0表示不考虑高度限制。

vehicleLength
query
  • number
float

车辆的长度(以米为单位)。 值0表示不考虑长度限制。

vehicleLoadType
query

可能会归类为危险材料并限制为某些道路的货物类型。 可用的 vehicleLoadType 值为 US Hazmat 类1到9以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值为 US 路由,而 otherHazmat 则用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅用于 travelMode = 卡车。

vehicleMaxSpeed
query
  • integer

车辆的最大速度(公里/小时)。 车辆配置文件中的最大速度用于检查是否允许在 motorways 上使用汽车。

  • 如果值为0,则表示在路由规划期间将确定并应用一个合适的车辆值。

  • 在路由规划过程中,可能会重写非零值。 例如,当前通信流为60千米/小时。 如果车辆的最大速度设置为50千米/小时,则路由引擎将考虑60千米/小时,因为这是当前情况。 如果车辆的最大速度以80公里/小时提供,但当前流量流为60千米/小时,则路由引擎将再次使用60千米/小时。

vehicleWeight
query
  • integer

车辆的重量(千克)。

  • 如果设置了任何 * 高效性参数,则此参数是必需的。

  • 在消耗模型的上下文中使用时,必须严格为正。 考虑权重限制。

  • 如果未指定详细的消耗模型并且vehicleWeight的值为非零,则考虑权重限制。

  • 在所有其他情况下,将忽略此参数。

合理值:对于Combustion 型号为1600,对于电气型号为:1900

vehicleWidth
query
  • number
float

车辆的宽度(以米为单位)。 值0表示不考虑宽度限制。

windingness
query

Thrilling 路由的级别。 此参数只能与 routeType = thrilling 一起使用。

请求头

Name Required Type Description
x-ms-client-id
  • string

指定哪个帐户将与 Azure AD 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 中检索。 若要在 Azure Maps 中使用 Azure AD 安全性,请参阅以下文章以获取指导。

响应

Name Type Description
200 OK

确定

Media Types: "application/json", "application/xml"

400 Bad Request

错误的请求:一个或多个参数未正确指定或互斥。

Media Types: "application/json", "application/xml"

401 Unauthorized

由于订阅密钥无效或 Azure Active Directory 持有者令牌无效,拒绝访问。 请确保为有效的 Azure 订阅提供有效密钥并映射资源。 否则,请验证WWW 身份验证标头中的错误代码和提供的 AAD 持有者令牌的说明。

Media Types: "application/json", "application/xml"

Headers

  • WWW-Authenticate: string
403 Forbidden

权限、容量或身份验证问题。

Media Types: "application/json", "application/xml"

404 Not Found

找不到:找不到请求的资源,但将来可能会再次提供该资源。

Media Types: "application/json", "application/xml"

500 Internal Server Error

处理该请求时出错。 请稍后重试。

Media Types: "application/json", "application/xml"

安全性

azure_auth

这些是Azure Active Directory OAuth2流。 与基于 Azure 角色的访问控制配对时,可以使用它来控制对 Azure Maps REST api 的访问。 使用 Azure 基于角色的访问控制来指定对一个或多个 Azure Maps 资源帐户或子资源的访问权限。 任何用户、组或服务主体都可以通过内置角色或自定义角色授予访问权限,该角色由一个或多个权限来 Azure Maps REST Api。

若要实现方案,建议查看身份验证概念。 总的来说,此安全定义提供一个解决方案,用于通过可访问控制的对象在特定的 Api 和作用域上对应用程序进行建模。

备注

  • 此安全定义需要使用 x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从映射管理 API中获取。
  • Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 Url 和 Azure Active directory 配置。
  • Azure 基于角色的访问控制是通过 Azure 门户、Powershell、CLI、Azure Sdk 或 REST Api 从azure 管理平面配置的。
  • Azure Maps WEB SDK的使用允许对多个用例的应用程序进行基于配置的配置。
  • 目前支持 Azure Active Directory 1.0版令牌。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

subscription-key

这是一个共享密钥,该密钥是通过 Azure 门户、Powershell、CLI、Azure Sdk 或 REST Api 通过 Azure 管理平面创建Azure Maps 资源时预配的。 使用此密钥,任何应用程序都有权访问所有 REST Api。 换句话说,这些密钥目前可以作为主密钥分配给颁发它们的帐户。 对于公开显示的应用程序,我们建议使用服务器对可以安全存储此密钥的 Azure Maps REST Api 进行服务器访问。

Type: apiKey
In: query

示例

GetRouteDirections

Sample Request

GET https://atlas.microsoft.com/route/directions/json?subscription-key=[subscription-key]&api-version=1.0&query=52.50931,13.42936:52.50274,13.43872

Sample Response

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

定义

AlternativeRouteType

根据给定的规划条件,控制与引用路由相比计算的替代项的最优性。

Avoid

指定路由计算在确定路由时应尽量避免的内容。 可以在一个请求中多次指定,例如 "&避免 = motorways&避免 = tollRoads&避免 = ferries"。 在 calculateReachableRange 请求中,不能使用 alreadyUsedRoads 值。

ComputeTravelTimeFor

指定是否使用不同类型的流量信息(无、历史、实时)以及默认的最佳估计行程时间来返回额外的行程时间。

Coordinate

表示为纬度和经度的位置。

DrivingSide

指示遍历点处的左侧与右侧驱动程序。

GuidanceInstructionType

指令的类型,例如,转换或更改道路窗体。

GuidanceManeuver

标识遍历的代码。

Hilliness

Thrilling 路由的 hilliness 度。 此参数只能与 routeType = thrilling 一起使用。

JunctionType

发生遍历的联接的类型。 对于更大的 roundabouts,将生成两个单独的指令用于输入和离开间接。

MagnitudeOfDelay

事件造成的延迟量。 这些值对应于Get 流量事件详细信息 API的响应字段 ty 的值。

ODataError

当映射 API 中出现错误时,将返回此对象。

ODataErrorResponse

当映射 API 中出现错误时,将返回此响应对象。

RouteDirectionsResponse

此对象从成功的路由方向调用返回

RouteDirectionsResult
RouteDirectionsSummary

Summary 对象

RouteInstructionsType

如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation = none 一起使用

RouteOptimizedWaypoint

优化方法点对象。

RouteRepresentation

指定作为响应提供的路由集的表示形式。 此参数值仅可与 computeBestOrder = true 一起使用。

RouteResponseReport

报告当前调用中使用的有效设置。

RouteResponseReportEffectiveSetting

调用此路由 API 时使用的有效参数或数据。

RouteResultGuidance

包含与准则相关的元素。 仅当请求了指南并且可用时,此字段才会出现。

RouteResultInstruction

描述遍历的一组属性,例如 "转到右侧"、"保留左侧"、"采用运送"、"接受高速公路"、"抵达"。

RouteResultInstructionGroup

对彼此相关的一系列指令元素进行分组。 序列范围由 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求用户可读文本消息以获取指南(instructionType = text 或标记)时,instructionGroup 会返回一条摘要消息(如果有)。

RouteResultLeg
RouteResultLegSummary

Route 部分的摘要对象。

RouteResultSection
RouteResultSectionTec

使用TPEG2-TEC标准中的定义的流量事件的详细信息。 可以包含 effectCode 并导致元素。

RouteResultSectionTecCause

流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义插图和说明。

RouteType

请求的路由类型。

SectionType

指定在路由响应中报告的部分类型。

例如,如果 sectionType = 行人,则将返回仅适用于 pedestrians 的部分。 可以使用多个类型。 默认的 sectionType 是指 travelMode 输入。 默认情况下,travelMode 设置为 car

TextFormat

所需的响应格式。 值可以是_json_或_xml_。

TravelMode

请求的路由的旅行模式。 如果未定义,则默认值为 "car"。 请注意,请求的 travelMode 可能不可用于整个路由。 如果请求的 travelMode 不可用于特定部分,则该部分的响应的 travelMode 元素将是 "其他"。 请注意,旅行模式总线、摩托车、出租车和 van 都是 BETA 版功能。 完全限制数据在所有区域中都不可用。 在calculateReachableRange请求中,不得使用值 "自行车" 和 "行人"。

VehicleEngineType

车辆的引擎类型。 指定详细的消耗模型时,它必须与vehicleEngineType的值保持一致。

VehicleLoadType

可能会归类为危险材料并限制为某些道路的货物类型。 可用的 vehicleLoadType 值为 US Hazmat 类1到9以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值为 US 路由,而 otherHazmat 则用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅用于 travelMode = 卡车。

Windingness

Thrilling 路由的级别。 此参数只能与 routeType = thrilling 一起使用。

AlternativeRouteType

根据给定的规划条件,控制与引用路由相比计算的替代项的最优性。

Name Type Description
anyRoute
  • string

允许返回任何备用路由,而不考虑它与最优性的引用路由之间的比较情况。

betterRoute
  • string

根据给定的规划条件,仅当它比引用路由更好时才返回备用路由。

Avoid

指定路由计算在确定路由时应尽量避免的内容。 可以在一个请求中多次指定,例如 "&避免 = motorways&避免 = tollRoads&避免 = ferries"。 在 calculateReachableRange 请求中,不能使用 alreadyUsedRoads 值。

Name Type Description
alreadyUsedRoads
  • string

避免多次使用同一路上。 与 = thrilling 结合时最有用 routeType

borderCrossings
  • string

避免在路由计算中出现边界交叉。

carpools
  • string

避免需要使用合用(HOV/高使用量车辆)车道的路由。

ferries
  • string

避免 ferries

motorways
  • string

避免 motorways

tollRoads
  • string

避免了收费道路。

unpavedRoads
  • string

避免 unpaved 道路

ComputeTravelTimeFor

指定是否使用不同类型的流量信息(无、历史、实时)以及默认的最佳估计行程时间来返回额外的行程时间。

Name Type Description
all
  • string

为所有类型的流量信息计算行程时间,并指定 noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds 和 liveTrafficIncidentsTravelTimeInSeconds 字段中的所有结果都包括在路由响应中的摘要中。

none
  • string

不计算额外的行程时间。

Coordinate

表示为纬度和经度的位置。

Name Type Description
latitude
  • number

纬度属性

longitude
  • number

经度属性

DrivingSide

指示遍历点处的左侧与右侧驱动程序。

Name Type Description
LEFT
  • string

左侧。

RIGHT
  • string

右边缘。

GuidanceInstructionType

指令的类型,例如,转换或更改道路窗体。

Name Type Description
DIRECTION_INFO
  • string

方向信息。

LOCATION_ARRIVAL
  • string

到达位置。

LOCATION_DEPARTURE
  • string

出发位置。

LOCATION_WAYPOINT
  • string

单向点位置。

ROAD_CHANGE
  • string

公路变动。

TURN
  • string

又.

GuidanceManeuver

标识遍历的代码。

Name Type Description
ARRIVE
  • string

您已经到达。

ARRIVE_LEFT
  • string

您已经到达。 你的目标位于左侧。

ARRIVE_RIGHT
  • string

您已经到达。 你的目标位于右侧。

BEAR_LEFT
  • string

左移。

BEAR_RIGHT
  • string

向右。

DEPART
  • string

遗留.

ENTER_FREEWAY
  • string

拿到高速公路。

ENTER_HIGHWAY
  • string

拿到高速公路。

ENTER_MOTORWAY
  • string

拿到高速公路。

ENTRANCE_RAMP
  • string

拿起。

FOLLOW
  • string

参照.

KEEP_LEFT
  • string

保持左侧。

KEEP_RIGHT
  • string

保持正确。

MAKE_UTURN
  • string

进行手杖形转换。

MOTORWAY_EXIT_LEFT
  • string

退出。

MOTORWAY_EXIT_RIGHT
  • string

请退出。

ROUNDABOUT_BACK
  • string

继续间接。

ROUNDABOUT_CROSS
  • string

跨间接。

ROUNDABOUT_LEFT
  • string

在间接上,将左侧的退出。

ROUNDABOUT_RIGHT
  • string

在间接上,将退出。

SHARP_LEFT
  • string

翻向左锐化。

SHARP_RIGHT
  • string

翻向右。

STRAIGHT
  • string

始终开启。

SWITCH_MAIN_ROAD
  • string

切换到主道路。

SWITCH_PARALLEL_ROAD
  • string

切换到并行道路。

TAKE_EXIT
  • string

退出。

TAKE_FERRY
  • string

获取运送。

TRY_MAKE_UTURN
  • string

尝试进行手杖形转换。

TURN_LEFT
  • string

左移。

TURN_RIGHT
  • string

右对齐。

WAYPOINT_LEFT
  • string

已达到 waypoint。 它位于左侧。

WAYPOINT_REACHED
  • string

已达到 waypoint。

WAYPOINT_RIGHT
  • string

已达到 waypoint。 它位于右侧。

Hilliness

Thrilling 路由的 hilliness 度。 此参数只能与 routeType = thrilling 一起使用。

Name Type Description
high
  • string

high

low
  • string

low

normal
  • string

一般

JunctionType

发生遍历的联接的类型。 对于更大的 roundabouts,将生成两个单独的指令用于输入和离开间接。

Name Type Description
BIFURCATION
  • string

分叉

REGULAR
  • string

普通

ROUNDABOUT
  • string

间接

MagnitudeOfDelay

事件造成的延迟量。 这些值对应于Get 流量事件详细信息 API的响应字段 ty 的值。

Name Type Description
0
  • string

未知。

1
  • string

次要。

2
  • string

适中。

3
  • string

主要。

4
  • string

未定义,用于公路和其他无限延迟。

ODataError

当映射 API 中出现错误时,将返回此对象。

Name Type Description
code
  • string

ODataError 代码。

details

当映射 API 中出现错误时,将返回此对象。

message
  • string

在适用的情况下,将提供该错误的用户可读说明。

target
  • string

如果有,则目标导致错误。

ODataErrorResponse

当映射 API 中出现错误时,将返回此响应对象。

Name Type Description
error

当映射 API 中出现错误时,将返回此对象。

RouteDirectionsResponse

此对象从成功的路由方向调用返回

Name Type Description
formatVersion
  • string

格式版本属性

optimizedWaypoints

优化的 waypoints 序列。 它显示用户为原始和优化列表提供的 waypoint 序列中的索引。 例如,响应:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

表示原始序列为 [0,1,2],而优化序列为 [1,2,0]。 由于索引以0开始,因此,在优化时为 "第一个、第二个、第三个"。

report

报告当前调用中使用的有效设置。

routes

路由阵列

RouteDirectionsResult

Name Type Description
guidance

包含与准则相关的元素。 仅当请求了指南并且可用时,此字段才会出现。

legs

支线数组

sections

Sections 数组

summary

Summary 对象

RouteDirectionsSummary

Summary 对象

Name Type Description
arrivalTime
  • string

到达时间属性

departureTime
  • string

出发时间属性

lengthInMeters
  • integer

时间长度(以米为单位)属性

trafficDelayInSeconds
  • integer

根据流量信息导致的实时事件的预计延迟时间(秒)。 对于计划在将来保留时间的路由,延迟始终为0。 若要使用不同类型的通信信息返回更多行程时间,需要添加参数 computeTravelTimeFor = all。

travelTimeInSeconds
  • integer

估计的持续时间(秒)属性,包括实时流量导致的延迟。 请注意,即使流量 = false travelTimeInSeconds 仍包含流量导致的延迟。 如果 DepartAt 是将来的,则使用与时间相关的历史流量数据来计算旅行时间。

RouteInstructionsType

如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation = none 一起使用

Name Type Description
coded
  • string

返回不包含人工可读消息的原始指令数据。

tagged
  • string

返回原始指令数据和带标签的可读消息以允许格式设置。 用户可读的消息是由可重复标识的元素生成的。 这些标记可让客户端应用程序正确格式化它们。 以下消息组件在 instructionsType = tag:街道、roadNumber、signpostText、exitNumber、roundaboutExitNumber 时进行标记。

标记为 "左移" 消息的示例:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>
text
  • string

返回纯文本形式的原始说明数据和用户可读的消息。

RouteOptimizedWaypoint

优化方法点对象。

Name Type Description
optimizedIndex
  • integer

从系统优化的点索引。

providedIndex
  • integer

用户提供的单向点索引。

RouteRepresentation

指定作为响应提供的路由集的表示形式。 此参数值仅可与 computeBestOrder = true 一起使用。

Name Type Description
none
  • string

只包含优化的 waypoint 索引,但不包括响应中的路由几何图形。

polyline
  • string

在响应中包括路由几何图形。

summaryOnly
  • string

按折线汇总,但不包括响应中的路由的点几何元素。

RouteResponseReport

报告当前调用中使用的有效设置。

Name Type Description
effectiveSettings

调用此路由 API 时使用的有效参数或数据。

RouteResponseReportEffectiveSetting

调用此路由 API 时使用的有效参数或数据。

Name Type Description
key
  • string

使用的参数的名称。

value
  • string

使用的参数的值。

RouteResultGuidance

包含与准则相关的元素。 仅当请求了指南并且可用时,此字段才会出现。

Name Type Description
instructionGroups

对彼此相关的一系列指令元素进行分组。

instructions

描述设法使其的说明的列表。

RouteResultInstruction

描述遍历的一组属性,例如 "转到右侧"、"保留左侧"、"采用运送"、"接受高速公路"、"抵达"。

Name Type Description
combinedMessage
  • string

与下一条指令中的消息结合使用的遍历的用户可读消息。 有时可以将两个连续的指令合并为单个指令,使其更易于理解。 在这种情况下,possibleCombineWithNext 标志将为 true。 例如:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

指令10上的 possibleCombineWithNext 标志为 true。 这向客户端表明,可以将其与指令11组合在一起。 对于请求可读指南的客户端,将自动组合这些说明。 CombinedMessage 字段包含合并的消息:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode
  • string

3个字符的ISO 3166-1 alpha-3 国家/地区代码。 例如 A.

drivingSide

指示遍历点处的左侧与右侧驱动程序。

exitNumber
  • string

当前遍历采用的高速公路出口数。 如果出口有多个出口号,它们将被 "," 分隔,并可能由 "-" 聚合,如 "10,13-15"。

instructionType

指令的类型,例如,转换或更改道路窗体。

junctionType

发生遍历的联接的类型。 对于更大的 roundabouts,将生成两个单独的指令用于输入和离开间接。

maneuver

标识遍历的代码。

message
  • string

遍历的用户可读消息。

point

表示为纬度和经度的位置。

pointIndex
  • integer

折线 "point" 列表中与指令点相对应的点的索引。

possibleCombineWithNext
  • boolean

可以选择将指令与下一个指令组合在一起。 这可用于生成消息,如 "左移" 和 "右对齐"。

roadNumbers
  • string[]

接下来遍历后的下一个显著路段的道路编号,或跟随的道路的路上。 示例: ["E34","N205"]

roundaboutExitNumber
  • string

这表示要在间接上执行的退出。

routeOffsetInMeters
  • integer

从路由开始到指令点之间的距离。

signpostText
  • string

Signpost 上与遍历最相关的文本,或与应遵循的方向相关的文本。

stateCode
  • string

国家/地区的细分(例如省/市/自治区),由ISO 3166-2代码的第二部分表示。 这仅适用于美国、加拿大和墨西哥等某些国家/地区。

street
  • string

遍历之后或应遵循的街道后的下一个重要路段的街道名称。

travelTimeInSeconds
  • integer

与 routeOffsetInMeters 相对应的预计生存时间。

turnAngleInDecimalDegrees
  • integer

指示指令的方向。 如果 junctionType 指示打开指令:

  • 180 = 手杖形
  • [-179,-1] = 左移
  • 0 = 直接 on (0度转换)
  • [1,179] = 右手转

如果 junctionType 指示分叉说明:

  • <0-保持左侧
  • >0-始终向右

RouteResultInstructionGroup

对彼此相关的一系列指令元素进行分组。 序列范围由 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求用户可读文本消息以获取指南(instructionType = text 或标记)时,instructionGroup 会返回一条摘要消息(如果有)。

Name Type Description
firstInstructionIndex
  • integer

第一个指令的索引。

groupLengthInMeters
  • integer

组的长度。

groupMessage
  • string

为指导请求用户可读文本消息时的摘要消息(instructionType = 文本或标记)。

lastInstructionIndex
  • integer

最后一条指令的索引。

RouteResultLeg

Name Type Description
points

点数组

summary

Route 部分的摘要对象。

RouteResultLegSummary

Route 部分的摘要对象。

Name Type Description
arrivalTime
  • string

到达时间属性

batteryConsumptionInkWh
  • number

使用省电模式估算的省电时间(kWh)。 如果将 vehicleEngineType 设置为电动,并指定 constantSpeedConsumptionInkWhPerHundredkm,则包括。 BatteryConsumptionInkWh 的值包含 recuperated 电,因此可以为负数(表示获得能源)。 如果同时指定了 maxChargeInkWh 和 currentChargeInkWh,则会限制 recuperation,以确保电池电量水平永远不会超过 maxChargeInkWh。 如果既没有指定 maxChargeInkWh 也没有指定 currentChargeInkWh,则会在消耗计算中使用不受约束的 recuperation。

departureTime
  • string

出发时间属性

fuelConsumptionInLiters
  • number

使用 Combustion 消耗模型的估计燃料消耗。 如果将 vehicleEngineType 设置为_combustion_并且指定 constantSpeedConsumptionInLitersPerHundredkm,则包含。 该值将为非负数。

historicTrafficTravelTimeInSeconds
  • integer

使用依赖于时间的历史流量数据计算出的预计旅行时间。 仅当查询中使用 computeTravelTimeFor = all 时才包含。

lengthInMeters
  • integer

时间长度(以米为单位)属性

liveTrafficIncidentsTravelTimeInSeconds
  • integer

使用实时速度数据计算的预计旅行时间。 仅当查询中使用 computeTravelTimeFor = all 时才包含。

noTrafficTravelTimeInSeconds
  • integer

预计的预计出差时间,就像流量条件(例如拥塞),路由没有延迟。 仅当查询中使用 computeTravelTimeFor = all 时才包含。

trafficDelayInSeconds
  • integer

根据流量信息导致的实时事件的预计延迟时间(秒)。 对于计划在将来保留时间的路由,延迟始终为0。 若要使用不同类型的通信信息返回更多行程时间,需要添加参数 computeTravelTimeFor = all。

travelTimeInSeconds
  • integer

估计的持续时间(秒)属性,包括实时流量导致的延迟。 请注意,即使流量 = false travelTimeInSeconds 仍包含流量导致的延迟。 如果 DepartAt 是将来的,则使用与时间相关的历史流量数据来计算旅行时间。

RouteResultSection

Name Type Description
delayInSeconds
  • integer

事件引起的延迟(以秒为单位)。

effectiveSpeedInKmh
  • integer

事件在 km/h 中的有效速度,平均超出其整个长度。

endPointIndex
  • integer

终结点索引属性

magnitudeOfDelay

事件造成的延迟量。 这些值对应于Get 流量事件详细信息 API的响应字段 ty 的值。

sectionType
  • string

节类型属性

simpleCategory
  • string

事件的类型。 当前可以卡纸、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅 "tec"。

startPointIndex
  • integer

开始点索引属性

tec

使用TPEG2-TEC标准中的定义的流量事件的详细信息。 可以包含 effectCode 并导致元素。

travelMode
  • string

旅行模式属性

RouteResultSectionTec

使用TPEG2-TEC标准中的定义的流量事件的详细信息。 可以包含 effectCode 并导致元素。

Name Type Description
causes

导致数组

effectCode
  • integer

对流量的影响。 在 tec001: EffectCode 表中包含一个值,该值在TPEG2-TEC标准中定义。 可用于根据严重性对流量事件进行颜色编码。

RouteResultSectionTecCause

流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义插图和说明。

Name Type Description
mainCauseCode
  • integer

流量事件的主要原因。 在 tec002: CauseCode 表中包含一个值,该值在TPEG2-TEC标准中定义。

subCauseCode
  • integer

流量事件的 subcause。 在 mainCauseCode 定义的子原因表中包含一个值,如TPEG2-TEC标准中所定义。

RouteType

请求的路由类型。

Name Type Description
eco
  • string

按经济和速度平衡的路由。

fastest
  • string

最快的路由。

shortest
  • string

按距离的最短路线。

thrilling
  • string

包含有趣或富有挑战性的道路,并尽可能少地使用 motorways。 你可以选择 "已包含的" 级别和 "hilliness" 的程度。 有关如何设置此设置的详细说明,请参阅 hilliness 和 windingness 参数。 计划使用 = thrilling 的路由的限制为900公里 routeType

SectionType

指定在路由响应中报告的部分类型。

例如,如果 sectionType = 行人,则将返回仅适用于 pedestrians 的部分。 可以使用多个类型。 默认的 sectionType 是指 travelMode 输入。 默认情况下,travelMode 设置为 car

Name Type Description
carTrain
  • string

如果路线包含汽车火车,请获取章节。

country
  • string

路由包含部件的国家/地区。

ferry
  • string

获取此路由是否包含 ferries 的部分。

motorway
  • string

获取此路由是否包含 motorways 的部分。

pedestrian
  • string

获取适用于 pedestrians 的部分。

tollRoad
  • string

获取需要 payed 收费的部分。

tollVignette
  • string

获取需要提供收费 vignette 的部分。

traffic
  • string

获取包含流量信息的部分。

travelMode
  • string

获取与请求参数相关的部分 travelMode

tunnel
  • string

如果路由包括隧道,则获取部分。

TextFormat

所需的响应格式。 值可以是_json_或_xml_。

Name Type Description
json
  • string

JavaScript 对象表示法的数据交换格式

xml
  • string

可扩展标记语言

TravelMode

请求的路由的旅行模式。 如果未定义,则默认值为 "car"。 请注意,请求的 travelMode 可能不可用于整个路由。 如果请求的 travelMode 不可用于特定部分,则该部分的响应的 travelMode 元素将是 "其他"。 请注意,旅行模式总线、摩托车、出租车和 van 都是 BETA 版功能。 完全限制数据在所有区域中都不可用。 在calculateReachableRange请求中,不得使用值 "自行车" 和 "行人"。

Name Type Description
bicycle
  • string

返回的路由针对自行车进行优化,包括使用自行车车道。

bus
  • string

返回的路由针对总线进行了优化,包括仅使用总线通道。 BETA 版功能。

car
  • string

返回的路由针对汽车进行了优化。

motorcycle
  • string

返回的路由针对摩托车进行了优化。 BETA 版功能。

pedestrian
  • string

返回的路由针对 pedestrians 进行了优化,包括使用 sidewalks。

taxi
  • string

返回的路由针对出租车进行了优化。 BETA 版功能。

truck
  • string

返回的路由针对商业车辆进行了优化,例如卡车。

van
  • string

返回的路由针对 van 进行了优化。 BETA 版功能。

VehicleEngineType

车辆的引擎类型。 指定详细的消耗模型时,它必须与vehicleEngineType的值保持一致。

Name Type Description
combustion
  • string

内部 combustion 引擎。

electric
  • string

电气引擎。

VehicleLoadType

可能会归类为危险材料并限制为某些道路的货物类型。 可用的 vehicleLoadType 值为 US Hazmat 类1到9以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值为 US 路由,而 otherHazmat 则用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅用于 travelMode = 卡车。

Name Type Description
USHazmatClass1
  • string

爆炸

USHazmatClass2
  • string

压缩气体

USHazmatClass3
  • string

Flammable liquids

USHazmatClass4
  • string

Flammable 实体

USHazmatClass5
  • string

Oxidizers

USHazmatClass6
  • string

Poisons

USHazmatClass7
  • string

放射性

USHazmatClass8
  • string

Corrosives

USHazmatClass9
  • string

杂项

otherHazmatExplosive
  • string

爆炸

otherHazmatGeneral
  • string

杂项

otherHazmatHarmfulToWater
  • string

对水有害

Windingness

Thrilling 路由的级别。 此参数只能与 routeType = thrilling 一起使用。

Name Type Description
high
  • string

high

low
  • string

low

normal
  • string

一般