13.3 ルーティング・エンジンのXML API

この項では、XML形式のルート・リクエストをルーティング・エンジンに送信する方法、およびルート・リクエスト(入力)とルート・レスポンス(出力)のXMLスキーマ定義(XSD)について説明します。XMLは、HTTPプロトコルを使用した構造化文書の送信に広く使用されています。HTTPリクエスト(GETまたはPOSTメソッド)を使用する場合、そのリクエストには、xml_requestというパラメータがあり、その値は、リクエストのXML文書が含まれる文字列であると想定されます。

ルーティング・エンジン・サーブレットへのリクエストの書式は、次のとおりです。

http://hostname:port/route-server-servlet-path?xml_request=xml-request

この形式の詳細は次のとおりです。

hostname: ルーティング・エンジンが実行されているサーバーのネットワーク・パスです。
port: アプリケーション・サーバーがリスニングするポートです。
route-server-servlet-path: ルーティング・エンジン・サーブレットのパスです(たとえば、routeserver/servlet/RouteServerServlet)。
xml-request: URLエンコードされたXMLリクエストです。HTMLのGETまたはPOSTメソッドを使用して送信されます。

入力XMLは、すべてのリクエストに必須です。出力は、XML文書になります。

単純なルート・リクエストでは、ルートIDを指定する必要があり、次の属性を1つ以上指定できます。

route_preference: fastestまたはshortest (デフォルト)
road_preference: highway (デフォルト)またはlocal
return_driving_directions (運転方向を戻すかどうか): trueまたはfalse (デフォルト)
return_hierarchical_directions (階層的な方向を戻すかどうか): trueまたはfalse (デフォルト)
return_locations (ルートおよび任意のサブルートの出発地と目的地のジオコード化された結果を戻す): trueまたはfalse (デフォルト)
return_subroutes (サブルートを戻すかどうか): true (マルチアドレス・ルートの場合はデフォルト、シングルアドレス・ルートの場合は無視)またはfalse
return_route_geometry (ルートの線ストリングの座標を戻すかどうか): trueまたはfalse (デフォルト)
return_subroute_geometry (各サブルートの線ストリングの座標を戻すかどうか): trueまたはfalse (マルチアドレス・ルートの場合はデフォルト)
return_segment_geometry (ルートのマヌーバごとに線ストリングの座標を戻すかどうか): trueまたはfalse (デフォルト)
return_detailed_geometry: true (デフォルト。詳細なジオメトリを戻す)またはfalse (総合的なジオメトリを戻す)
language: 運転方向の生成に使用する言語(ENGLISH (デフォルト)、FRENCH、GERMAN、ITALIANまたはSPANISH)
distance_unit: kilometer、mile (デフォルト)またはmeter
length_unit: フィートの場合はus (デフォルト)、メートルの場合はmetric
time_unit: hour、minute (デフォルト)またはsecond
weight_unit: トンの場合はus (デフォルト)、メートル・トンの場合はmetric
pre_geocoded_locations (出発地および目的地を、入力場所(住所指定または点)とジオコード済の場所のどちらで指定するか): true (ジオコード済の場所)またはfalse (デフォルト。入力場所)
driving_directions_detail: high、medium (デフォルト)またはlow
optimize_route: trueまたはfalse (デフォルト)
route_type: open (デフォルト)またはclosed
vehicle_type: auto (デフォルト)またはtruck
truck_type: delivery、public、residentまたはtrailer。(デフォルトなし)
truck_height: length_unitsの浮動小数点数
truck_length: length_unitsの浮動小数点数
truck_per_axle_weight: weight_unitsの浮動小数点数
truck_weight: weight_unitsの浮動小数点数
truck_width: length_unitsの浮動小数点数

一括ルート・リクエストは、<batch_route_request>要素にカプセル化された1つ以上の単純(単一、マルチアドレスまたはTSP)リクエストのグループです。<batch_route_request>要素に関連する属性はすべて無視されます。カプセル化されたすべてのリクエストは単純リクエストであるため、これらは前にリストした属性を使用します。

バッチ・モード・ルート・リクエストでは、リクエストID、出発地、および1つ以上の目的地を指定する必要があります。ID属性は、場所ごとに必要です。単純リクエストに使用されるほとんどの属性は、バッチ・モードでは意味がありません。バッチ・モード・ルート・リクエストで次の属性の1つ以上を使用できますが、このリストにない属性を使用すると例外が発生する原因となります。

route_preference: fastestまたはshortest (デフォルト)
road_preference: highway (デフォルト)またはlocal
distance_unit: kilometer、km、mile (デフォルト)またはmeter
time_unit: hour、minute (デフォルト)またはsecond
sort_by_distance (戻されるルートを、出発地から目的地までの距離で昇順にソートするかどうか): trueまたはfalse (デフォルト)
cutoff_distance (出発地から目的地までの距離が、指定された距離以下のルートのみを戻す): (数値。デフォルトは制限なし)
pre_geocoded_locations (出発地および目的地を、入力場所(住所指定または点)とジオコード済の場所のどちらで指定するか): true (ジオコード済の場所)またはfalse (デフォルト。入力場所)

この項には次のトピックが含まれます: