区間インデックス

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

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

明示的な区間インデックスはレスポンスに含まれません。Lineオブジェクトがそれらを含む配列の何番目であるかが、それぞれの区間の区間インデックスにあたります。

レスポンス例

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

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

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

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

GET /v1/json/search/course/extreme?viaList=22671:22828:25978:25853&answerCount=1&key=アクセスキーを入力してください

{
  "ResultSet": {
    "Course": [
      {
        "Route": {
          "Line": [
            // 区間インデックス1にあたる区間
            {
              "Name": "ＪＲ中央線快速・東京行",
              // ...
            },
            // 区間インデックス2にあたる区間
            {
              "Name": "ＪＲ新幹線のぞみ",
              // ...
            },
            // 区間インデックス3にあたる区間
            {
              "Name": "ＪＲ京都線・西明石行",
              // ...
            }
          ],
          // ...
        }
      }
    ]
  }
}

JSON形式でのレスポンスでは、Lineオブジェクトがそれらを含む配列の何番目であるかが、それぞれの区間の区間インデックスにあたります。
よってこの場合のそれぞれの区間の区間インデックスは、以下の通りです。

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