你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Route - Post Route Directions Batch Sync

路由方向批处理 API

适用于:查看定价

路由方向批处理 API 仅使用单个 API 调用将一批查询发送到 路由方向 API 。 可以调用路由方向 Batch API 以异步方式 (异步) 运行,也可以同步 (同步) 运行。 异步 API 允许调用方对多达 700 个查询进行批处理,并将 API 同步到 100 个查询。

提交同步批处理请求

对于轻型批处理请求,建议使用同步 API。 当服务收到请求时,它将在计算批处理项后立即响应,并且以后无法检索结果。 如果请求超过 60 秒,同步 API 将返回一个超时错误, (408 响应) 。 此 API 的批项数限制为 100 个。

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

批处理响应模型

返回的数据内容与异步和同步请求类似。 下载异步批处理请求的结果时,如果批处理已完成处理,响应正文将包含批处理响应。 此批处理响应包含一个 summary 组件,该 totalRequests 组件指示原始批处理请求的一部分, successfulRequests即已成功执行的查询。 批处理响应还包括一个 batchItems 数组,其中包含批处理请求中每个查询的响应。 该 batchItems 命令将包含结果,其顺序与原始查询在批处理请求中发送的顺序完全相同。 每个项 batchItems 都包含 statusCoderesponse 字段。 每个 response 类型 batchItems 都具有以下类型之一:

  • RouteDirections - 如果查询成功完成。

  • Error - 如果查询失败。 响应将包含一 code 个和一个 message 在本例中。

下面是一个包含 1 个成功 和 1 个失败 结果的示例 Batch 响应:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

URI 参数

Name In Required Type Description
format
path True

响应的所需格式。 仅支持 json 格式。

api-version
query True
  • string

Azure Maps API 的版本号。

请求头

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

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

请求正文

Name Type Description
batchItems

要处理的查询列表。

响应

Name Type Description
200 OK

确定

Other Status Codes

超时:请求完成时间比 API 中定义的最大时间长。

Other Status Codes

发生了意外错误。

安全性

AADToken

这些是 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 v1.0 或 v2.0 支持工作、学校和来宾,但不支持个人帐户。

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

这是在Azure 门户或使用 PowerShell、CLI、Azure SDK 或 REST API 中创建Azure Maps帐户时预配的共享密钥。

使用此密钥,任何应用程序都可以访问所有 REST API。 换句话说,此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序,建议使用机密客户端应用程序方法来访问 Azure Maps REST API,以便安全地存储密钥。

Type: apiKey
In: query

SAS Token

这是通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上的列表 SAS 操作创建的共享访问签名令牌。

使用此令牌时,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域 () 。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序,建议在 地图帐户资源 上配置允许的源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。

Type: apiKey
In: header

示例

Successfully retrieve the route direction batch result synchronously

Sample Request

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Sample Response

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

定义

BatchRequest

此类型表示 Batch 服务的请求正文。

BatchRequestItem

Batch 请求对象

DelayMagnitude

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

DrivingSide

指示在机动点的左侧与右侧驾驶。

EffectiveSetting

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GuidanceInstructionType

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

GuidanceManeuver

标识操作的代码。

JsonFormat

响应的所需格式。 仅支持 json 格式。

JunctionType

操作发生位置的交界点的类型。 对于较大的环道,将生成两个单独的指令,用于进入和离开环岛。

LatLongPair

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

Response

查询结果。 如果查询成功完成,则 RouteDirections;否则为 ErrorResponse。

ResponseSectionType

报告的路由响应的节类型

ResponseTravelMode

计算路线的旅行模式。 如果请求的传输模式在本节中不可用,该值将设置为other

Route
RouteDirectionsBatchItem

从 Route Directions Batch 服务调用返回的项。

RouteDirectionsBatchResult

此对象是从成功的路由方向批处理服务调用返回的。

RouteGuidance

包含与指南相关的元素。 仅当请求并可用指导时,才会显示此字段。

RouteInstruction

描述操纵的一组属性,例如“向右转”、“保持左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。

RouteInstructionGroup

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

RouteLeg

路线的一部分的说明,由点列表组成。 请求中提供的每个附加路点将导致返回的路线中附加一条腿。

RouteLegSummary

路由节的摘要对象。

RouteOptimizedWaypoint

优化的方式点对象。

RouteReport

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

RouteSection

路由部分包含有关路由部分的其他信息。 每个节至少包含元素startPointIndexendPointIndexsectionType

RouteSectionTec

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

RouteSectionTecCause

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

RouteSummary

Summary 对象

SimpleCategory

事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。

Summary

批处理请求结果摘要

BatchRequest

此类型表示 Batch 服务的请求正文。

Name Type Description
batchItems

要处理的查询列表。

BatchRequestItem

Batch 请求对象

Name Type Description
query
  • string

此参数包含用于执行非结构化地理编码操作的查询字符串。 查询字符串将逐字传递给搜索 API 进行处理。

DelayMagnitude

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

Name Type Description
0
  • string

未知。

1
  • string

次要。

2
  • string

适中。

3
  • string

主要。

4
  • string

未定义,用于道路关闭和其他无限期延误。

DrivingSide

指示在机动点的左侧与右侧驾驶。

Name Type Description
LEFT
  • string

左侧。

RIGHT
  • string

右侧。

EffectiveSetting

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

Name Type Description
key
  • string

所使用的参数的名称。

value
  • string

所使用的参数的值。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

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

变成 U 轮次。

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

尝试进行 U 轮次。

TURN_LEFT
  • string

左转。

TURN_RIGHT
  • string

向右转。

WAYPOINT_LEFT
  • string

你已经到达了路点。 它位于左侧。

WAYPOINT_REACHED
  • string

你已经到达了路点。

WAYPOINT_RIGHT
  • string

你已经到达了路点。 它位于右侧。

JsonFormat

响应的所需格式。 仅支持 json 格式。

Name Type Description
json
  • string

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

JunctionType

操作发生位置的交界点的类型。 对于较大的环道,将生成两个单独的指令,用于进入和离开环岛。

Name Type Description
BIFURCATION
  • string

分 岔

REGULAR
  • string

普通

ROUNDABOUT
  • string

回旋 处

LatLongPair

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

Name Type Description
latitude
  • number

Latitude 属性

longitude
  • number

经度属性

Response

查询结果。 如果查询成功完成,则 RouteDirections;否则为 ErrorResponse。

Name Type Description
error

错误对象。

formatVersion
  • string

Format Version 属性

optimizedWaypoints

优化了路点序列。 它显示用户提供的原始列表和优化列表的路点序列的索引。 例如,响应:

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

表示原始序列为 [0, 1, 2] 且优化序列为 [1, 2, 0]。 由于索引从 0 开始,原始索引为“first,second,third”,而优化为“second,third,first”。

report

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

routes

路由数组

ResponseSectionType

报告的路由响应的节类型

Name Type Description
CARPOOL
  • string

需要使用汽车池 (HOV/高占用车辆) 车道的路线部分。

CAR_TRAIN
  • string

是汽车或火车的路线部分。

COUNTRY
  • string

指示路线所在的国家/地区的部分。

FERRY
  • string

渡轮路线的各部分。

MOTORWAY
  • string

高速公路的路段。

PEDESTRIAN
  • string

仅适合行人的路线部分。

TOLL_ROAD
  • string

需要支付通行费的路线部分。

TOLL_VIGNETTE
  • string

需要提供收费 vignette 的路线部分。

TRAFFIC
  • string

包含流量信息的路由部分。

TRAVEL_MODE
  • string

与请求参数 travelMode相关的节。

TUNNEL
  • string

属于隧道的路由部分。

URBAN
  • string

位于市区的路线部分。

ResponseTravelMode

计算路线的旅行模式。 如果请求的传输模式在本节中不可用,该值将设置为other

Name Type Description
bicycle
  • string

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

bus
  • string

返回的路线针对公共汽车进行了优化,包括仅使用公共汽车车道。 BETA 功能。

car
  • string

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

motorcycle
  • string

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

other
  • string

本节中无法提供给定的传输模式

pedestrian
  • string

返回的路线针对行人进行了优化,包括人行道的使用。

taxi
  • string

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

truck
  • string

返回的路线针对商用车辆(如卡车)进行了优化。

van
  • string

返回的路线针对面包车进行了优化。 BETA 功能。

Route

Name Type Description
guidance

包含与指南相关的元素。 仅当请求并可用指导时,才会显示此字段。

legs

腿数组

sections

节数组

summary

Summary 对象

RouteDirectionsBatchItem

从 Route Directions Batch 服务调用返回的项。

Name Type Description
response

查询结果。 如果查询成功完成,则 RouteDirections;否则为 ErrorResponse。

statusCode
  • integer

HTTP 请求状态代码。

RouteDirectionsBatchResult

此对象是从成功的路由方向批处理服务调用返回的。

Name Type Description
batchItems

包含批处理结果的数组。

summary

批处理请求结果摘要

RouteGuidance

包含与指南相关的元素。 仅当请求并可用指导时,才会显示此字段。

Name Type Description
instructionGroups

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

instructions

描述操作的说明列表。

RouteInstruction

描述操纵的一组属性,例如“向右转”、“保持左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。

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 国家/地区代码。 例如美国

drivingSide

指示在机动点的左侧与右侧驾驶。

exitNumber
  • string

当前机动采取的公路出口 () 的数量。 如果退出具有多个退出编号,则它们将被“-”分隔,并可能由“-”聚合,例如“10,13-15”。

instructionType

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

junctionType

操作发生位置的交界点的类型。 对于较大的环道,将生成两个单独的指令,用于进入和离开环岛。

maneuver

标识操作的代码。

message
  • string

一个人类可读的信息,用于操纵。

point

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

pointIndex
  • integer

与指令点对应的折线“磅”列表中的点的索引。

possibleCombineWithNext
  • boolean

可以选择将指令与下一个指令组合在一起。 这可用于生成消息,例如“左转,然后向右转”。

roadNumbers
  • string[]

下一重大路段) (路号 (后) ,或者要跟踪 () 道路的路号。 示例:[“E34”、“N205”]

roundaboutExitNumber
  • string

这表示在环流处要采取的退出。

routeOffsetInMeters
  • integer

从路线开始到指令点的距离。

signpostText
  • string

路标上的文本与操纵最相关,或与应遵循的方向有关。

stateCode
  • string

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

street
  • string

动作后下一条重要路段的街道名称,或应遵循的街道的名称。

travelTimeInSeconds
  • integer

估计到与 RouteOffsetInMeters 对应的点的行程时间。

turnAngleInDecimalDegrees
  • integer

指示指令的方向。 如果 junctionType 指示轮次指令:

  • 180 = U 轮次
  • [-179, -1] = 左转
  • 0 = 直接 (“0 度”轮次)
  • [1, 179] = 右转

如果 junctionType 指示分叉指令:

  • <0 - 保留左侧
  • >0 - 保持正确

RouteInstructionGroup

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

Name Type Description
firstInstructionIndex
  • integer

指令中的第一个指令的索引,并属于此组。

groupLengthInMeters
  • integer

组的长度。

groupMessage
  • string

当请求人工可读文本消息时摘要消息, (instructionType=text 或标记) 。

lastInstructionIndex
  • integer

指令中最后一个指令的索引,属于此组。

RouteLeg

路线的一部分的说明,由点列表组成。 请求中提供的每个附加路点将导致返回的路线中附加一条腿。

Name Type Description
points

点数组

summary

路由节的摘要对象。

RouteLegSummary

路由节的摘要对象。

Name Type Description
arrivalTime
  • string

路线或腿部的估计到达时间。

batteryConsumptionInkWh
  • number

使用电耗模型 (千瓦时) 估计的电力能耗。 如果 vehicleEngineType 设置为电动,并且指定 constantSpeedConsumptionInkWhPerHundredkm,则包含该类型。 batteryConsumptionInkWh 的值包括回收的电力,因此可以是负 (,这表示获得能量) 。 如果同时指定 maxChargeInkWh 和 currentChargeInkWh,则恢复将被封顶,以确保电池充电级别永远不会超过 maxChargeInkWh。 如果未指定 maxChargeInkWh 和 currentChargeInkWh,则会在消耗计算中假定不受约束的恢复。

departureTime
  • string

路线或腿部的估计出发时间。

fuelConsumptionInLiters
  • number

使用燃烧消耗模型估计升的燃油消耗量。 如果 vehicleEngineType 设置为 燃烧 ,并且指定 constantSpeedConsumptionInLitersPerHundredkm,则包含该类型。 该值将为非负值。

historicTrafficTravelTimeInSeconds
  • integer

使用依赖于时间的历史流量数据计算的估计行程时间。 仅当 computeTravelTimeFor = 所有在查询中使用时才包含。

lengthInMeters
  • integer

Length In Meters 属性

liveTrafficIncidentsTravelTimeInSeconds
  • integer

使用实时速度数据计算的估计行程时间。 仅当 computeTravelTimeFor = 所有在查询中使用时才包含。

noTrafficTravelTimeInSeconds
  • integer

由于交通状况 ((例如拥堵) ),估计的行程时间计算为路线上没有延误。 仅当 computeTravelTimeFor = 所有在查询中使用时才包含。

trafficDelayInSeconds
  • integer

根据交通信息,实时事件 () 造成的估计延迟(以秒为单位)。 对于计划在将来出发时间的航线,延误始终为 0。 若要使用不同类型的交通信息返回其他旅行时间,需要添加参数 computeTravelTimeFor=all。

travelTimeInSeconds
  • integer

估计的行程时间(以秒为单位)属性,其中包括由于实时流量导致的延迟。 请注意,即使 traffic=false travelTimeInSeconds 仍包含由于流量导致的延迟。 如果 DepartAt 在将来,则使用依赖于时间的历史交通数据计算旅行时间。

RouteOptimizedWaypoint

优化的方式点对象。

Name Type Description
optimizedIndex
  • integer

从系统优化的方式点索引。

providedIndex
  • integer

用户提供的路点索引。

RouteReport

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

Name Type Description
effectiveSettings

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

RouteSection

路由部分包含有关路由部分的其他信息。 每个节至少包含元素startPointIndexendPointIndexsectionType

Name Type Description
delayInSeconds
  • integer

事件导致的延迟(以秒为单位)。

effectiveSpeedInKmh
  • integer

事件的有效速度(以公里/小时为单位)平均超过其整个长度。

endPointIndex
  • integer

此部分适用的路由中最后一个点的索引 (偏移量 0) 。

magnitudeOfDelay

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

sectionType

报告的路由响应的节类型

simpleCategory

事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。

startPointIndex
  • integer

本部分适用的路由中第一个点 (偏移量 0) 的索引。

tec

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

travelMode

计算路线的旅行模式。 如果请求的传输模式在本节中不可用,该值将设置为other

RouteSectionTec

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

Name Type Description
causes

导致数组

effectCode
  • integer

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

RouteSectionTecCause

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

Name Type Description
mainCauseCode
  • integer

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

subCauseCode
  • integer

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

RouteSummary

Summary 对象

Name Type Description
arrivalTime
  • string

路线或腿部的估计到达时间。

departureTime
  • string

路线或腿部的估计出发时间。

lengthInMeters
  • integer

Length In Meters 属性

trafficDelayInSeconds
  • integer

根据交通信息,实时事件 () 造成的估计延迟(以秒为单位)。 对于计划在将来出发时间的航线,延误始终为 0。 若要使用不同类型的交通信息返回其他旅行时间,需要添加参数 computeTravelTimeFor=all。

travelTimeInSeconds
  • integer

估计的行程时间(以秒为单位)属性,其中包括由于实时流量导致的延迟。 请注意,即使 traffic=false travelTimeInSeconds 仍包含由于流量导致的延迟。 如果 DepartAt 在将来,则使用依赖于时间的历史交通数据计算旅行时间。

SimpleCategory

事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。

Name Type Description
JAM
  • string

交通堵塞。

OTHER
  • string

其他。

ROAD_CLOSURE
  • string

道路关闭。

ROAD_WORK
  • string

道路工作。

Summary

批处理请求结果摘要

Name Type Description
successfulRequests
  • integer

批处理中成功的请求数

totalRequests
  • integer

批处理中的请求总数