列車等の停車駅情報

特定の列車等の停車駅一覧を取得します。

GET /v1/{format}/course/trainStation

取得の処理の流れ

  1. 経路探索を行い、列車の一覧を取得したい区間を決める
  2. 平均路線情報経路シリアライズデータと区間インデックスを指定し、区間の列車等の一覧を取得する
  3. 列車等の一覧から停車駅一覧を取得したい列車等を決め、そのLine要素のcode属性の値を取得する
  4. 先の経路シリアライズデータと区間インデックスに加え、3で取得した値をlineCodeに指定して停車駅の一覧を取得する

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須。
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキーの指定。必須
serializeData string 経路シリアライズデータ。必須
checkEngineVersion string 完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:
- true: チェックする
- false: チェックしない
Default: true
sectionIndex int 区間インデックス
lineCode int 列車等を特定するコード
詳しくはこちらを参照。
sectionOnly string 停車駅取得の範囲。省略可。
指定できる値:
- true: 区間のみ
- false: 全体
Default: true
詳しくはこちらを参照。
gcs string リクエストやレスポンスに座標が含まれる場合、座標の測地系を指定することができます。また、リクエストパラメータの座標情報はgcsパラメータとは別の測地系を個別に指定可能です。省略可。
指定できる値:
- tokyo: 日本測地系
- wgs84: 世界測地系
Default: tokyo

lineCode

lineCodeは区間を走る列車等を特定するための値です。 この値には、平均路線情報経路シリアライズデータと区間インデックスを指定した際の結果に含まれるLine要素のcode属性を利用します、 鉄道駅時刻表の結果に含まれるStop要素のlineCode属性は利用できません。

sectionOnly

sectionOnlyで指定できる、停車駅取得の範囲についてです。

池袋(13:00)―山手線→(13:08)新宿(13:12)―中央線→(13:29)三鷹

という経路で、区間インデックスに"2"(=新宿三鷹間)を指定した場合、その区間の中央線の列車は、

東京[始発](12:58)――――(13:12)新宿(13:12)====(13:29)三鷹(13:29)――――(13:51)立川[終点]

になります。二重線部分が、経路に含まれる区間です。

このとき、sectionOnlyがtrueの場合は、経路の区間である新宿三鷹間(二重線の部分)の停車駅を取得できます。

secttionOnlyがfalseの場合は、区間の前後(始発の東京から終点の立川まで)を含む停車駅を取得できます。

response

Name Description
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / Line 区間を表す要素
ResultSet / Line / index インデックス。
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / Line / ArrivalState 到着時の状態を表す要素
ResultSet / Line / ArrivalState / Datetime 到着日時を表す要素
ResultSet / Line / ArrivalState / Datetime / operation 運行日判定。
- today: 日時通り
- yesterday: 前日
ResultSet / Line / DepartureState 出発時の状態を表す要素
ResultSet / Line / DepartureState / Datetime 出発日時を表す要素
ResultSet / Line / DepartureState / Datetime / operation 運行日判定。
- today: 日時通り
- yesterday: 前日
ResultSet / Point 地点を表す要素
ResultSet / Point / index インデックス。
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / Point / getOff 降車可能フラグ。
- true: 可能
- false: 不可能
ResultSet / Point / getOn 乗車可能フラグ。
- true: 可能
- false: 不可能
ResultSet / Point / onRoute 区間内フラグ。
- true: 対象経路の区間内
- false: 区間外
ResultSet / Point / onRouteEdge 区間の端フラグ。
- true: 対象経路の端
- false: 端以外
ResultSet / Point / GeoPoint 座標を表す要素
ResultSet / Point / GeoPoint / gcs 測地系
ResultSet / Point / GeoPoint / lati 緯度。
Format: 度.分.秒.100分の1秒
ResultSet / Point / GeoPoint / lati_d 緯度。
Format:
ResultSet / Point / GeoPoint / longi 経度。
Format: 度.分.秒.100分の1秒
ResultSet / Point / GeoPoint / longi_d 経度。
Format:
ResultSet / Point / Prefecture 都道府県を表す要素
ResultSet / Point / Prefecture / code 都道府県コード
ResultSet / Point / Prefecture / Name 都道府県の名称
ResultSet / Point / Station を表す要素
ResultSet / Point / Station / code 駅コード
ResultSet / Point / Station / Name 駅の名称を表す要素
ResultSet / Point / Station / Type 交通種別を表す要素
ResultSet / Point / Station / Yomi 読みかなを表す要素

example

GET /v1/xml/course/trainStation?serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041&sectionIndex=1&lineCode=Both:1
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Point index="1">
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.702110" longi_d="139.653027" lati="35.42.7.59" longi="139.39.10.89"/>
    <Station code="22671">
      <Name>高円寺</Name>
      <Yomi>こうえんじ</Yomi>
      <Type>train</Type>
    </Station>
  </Point>
  <Line index="1">
    <DepartureState>
      <Datetime operation="today">04:51:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">04:54:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Point index="2">
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.702582" longi_d="139.669166" lati="35.42.9.29" longi="139.40.9.0"/>
    <Station code="22849">
      <Name>中野(東京都)</Name>
      <Yomi>なかの</Yomi>
      <Type>train</Type>
    </Station>
  </Point>
  <Line index="2">
    <DepartureState>
      <Datetime operation="today">04:54:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">04:57:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Point index="3">
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.703333" longi_d="139.686666" lati="35.42.12.0" longi="139.41.12.0"/>
    <Station code="22936">
      <Name>東中野</Name>
      <Yomi>ひがしなかの</Yomi>
      <Type>train</Type>
    </Station>
  </Point>
  <Line index="3">
    <DepartureState>
      <Datetime operation="today">04:57:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">04:59:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Point index="4">
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.697194" longi_d="139.700833" lati="35.41.49.89" longi="139.42.3.0"/>
    <Station code="22558">
      <Name>大久保(東京都)</Name>
      <Yomi>おおくぼ</Yomi>
      <Type>train</Type>
    </Station>
  </Point>
  <Line index="4">
    <DepartureState>
      <Datetime operation="today">04:59:00+09:00</Datetime>
    </DepartureState>
    <ArrivalState>
      <Datetime operation="today">05:02:00+09:00</Datetime>
    </ArrivalState>
  </Line>
  <Point index="5">
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <GeoPoint gcs="tokyo" lati_d="35.6875" longi_d="139.703055" lati="35.41.15.0" longi="139.42.11.0"/>
    <Station code="22741">
      <Name>新宿</Name>
      <Yomi>しんじゅく</Yomi>
      <Type>train</Type>
    </Station>
  </Point>
</ResultSet>
GET /v1/json/course/trainStation?serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041&sectionIndex=1&lineCode=Both:1
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Point": [
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "GeoPoint": {
          "gcs": "tokyo",
          "lati_d": "35.702110",
          "longi_d": "139.653027",
          "lati": "35.42.7.59",
          "longi": "139.39.10.89"
        },
        "Station": {
          "code": "22671",
          "Name": "高円寺",
          "Yomi": "こうえんじ",
          "Type": "train"
        }
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "GeoPoint": {
          "gcs": "tokyo",
          "lati_d": "35.702582",
          "longi_d": "139.669166",
          "lati": "35.42.9.29",
          "longi": "139.40.9.0"
        },
        "Station": {
          "code": "22849",
          "Name": "中野(東京都)",
          "Yomi": "なかの",
          "Type": "train"
        }
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "GeoPoint": {
          "gcs": "tokyo",
          "lati_d": "35.703333",
          "longi_d": "139.686666",
          "lati": "35.42.12.0",
          "longi": "139.41.12.0"
        },
        "Station": {
          "code": "22936",
          "Name": "東中野",
          "Yomi": "ひがしなかの",
          "Type": "train"
        }
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "GeoPoint": {
          "gcs": "tokyo",
          "lati_d": "35.697194",
          "longi_d": "139.700833",
          "lati": "35.41.49.89",
          "longi": "139.42.3.0"
        },
        "Station": {
          "code": "22558",
          "Name": "大久保(東京都)",
          "Yomi": "おおくぼ",
          "Type": "train"
        }
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "GeoPoint": {
          "gcs": "tokyo",
          "lati_d": "35.6875",
          "longi_d": "139.703055",
          "lati": "35.41.15.0",
          "longi": "139.42.11.0"
        },
        "Station": {
          "code": "22741",
          "Name": "新宿",
          "Yomi": "しんじゅく",
          "Type": "train"
        }
      }
    ],
    "Line": [
      {
        "DepartureState": {
          "Datetime": {
            "text": "04:51:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "04:54:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "DepartureState": {
          "Datetime": {
            "text": "04:54:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "04:57:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "DepartureState": {
          "Datetime": {
            "text": "04:57:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "04:59:00+09:00",
            "operation": "today"
          }
        }
      },
      {
        "DepartureState": {
          "Datetime": {
            "text": "04:59:00+09:00",
            "operation": "today"
          }
        },
        "ArrivalState": {
          "Datetime": {
            "text": "05:02:00+09:00",
            "operation": "today"
          }
        }
      }
    ]
  }
}