区間インデックス

経路探索によって得られた1つの経路の中で、何番目の区間であるかを示すインデックスです。
先頭の区間の区間インデックスは1です。また末尾の区間の区間インデックスは、その経路の区間数と一致します。

※ API利用時のイメージ図 駅すぱあと for web


経路から任意の区間の区間インデックスを取得する方法は、経路の取得をXMLで行ったか、JSONで行ったかによって異なります。
XMLで行った場合、それぞれのLine要素が持つindex属性が、区間インデックスにあたります。
またJSONで行った場合、明示的な区間インデックスはレスポンスに含まれません。LINE要素が複数存在する時、それらを含む配列の何番目であるかが、それぞれの区間の区間インデックスにあたります。

それぞれ詳細および注意事項は XML形式のレスポンスデータを利用する際の注意事項 もしくは JSON形式のレスポンスデータを利用する際の注意事項をご覧ください。

レスポンス例

高円寺駅から大阪駅の経路を探索した場合

例えば次のような経路を探索したとします。

高円寺-(JR中央線)-東京-(東海道新幹線)-新大阪-(JR京都線)-大阪


この場合、経路探索の結果、以下のレスポンスが得られます。

GET /v1/xml/search/course/extreme?viaList=22671:22828:25978:25853&answerCount=1&key=アクセスキーを入力してください
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201808_02a">
  <Course searchType="departure" dataType="onTimetable">
    <Route index="1" transferCount="2" ...>
      <Point index="1">...</Point>
      <!-- index属性(区間インデックスにあたる)のついたLine要素 -->
      <Line index="1" stopStationCount="5" track="railway"...>
        <Name>JR中央線快速・東京行</Name>
          :
      </Line>
      <Point index="2">...</Point>
      <!-- index属性(区間インデックスにあたる)のついたLine要素 -->
      <Line index="2" stopStationCount="4" track="railway">
        <Name>JR新幹線のぞみ</Name>
          :
      </Line>
      <Point index="3">...</Point>
      <!-- index属性(区間インデックスにあたる)のついたLine要素 -->
      <Line index="3" stopStationCount="0" track="railway">
        <Name>JR京都線・西明石行</Name>
          :
      </Line>
      <Point index="4">...</Point>
    </Route>
      :
  </Course>
</ResultSet>

XML形式でのレスポンスでは、それぞれのLine要素が持つindex属性が、区間インデックスにあたります。
よってこの場合のそれぞれの区間の区間インデックスは、以下の通りです。

区間 区間インデックス
高円寺-(JR中央線)-東京 1
東京-(東海道新幹線)-新大阪 2
新大阪-(JR京都線)-大阪 3