路線別運行情報検索
/operation_train/link [GET]
基本情報
概要
路線ID等を指定して運行情報を取得します。
※当APIをご利用の場合は、専用データ利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/operation_train/link
※APIマーケットでは提供しておりません
出力形式
- JSON
対応言語
- ja
出力順
- 発生時刻の降順
パラメータ
パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
---|---|---|---|---|---|---|
link | ✔ | 路線ID | 文字列 | ピリオド区切りで複数指定可能 | ||
term | 探索時間の範囲(単位:分) | 数値 | 最小値:1 最大値:2880 |
運行情報を現在時刻から指定されたtermの範囲内に絞りこみます |
パラメータ構成例
- 千代田線に関する運行情報を取得
/operation_train/link?link=00000769
レスポンス
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
鉄道運行情報 | items | TrainAccidentReportオブジェクト | ○ | 鉄道運行情報のまとまり |
TrainAccidentReportオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
運行情報ID | id | 文字列 | ||
スレッドID | thread_id | 文字列 | ||
発生時刻 | date | 文字列 | ||
該当路線の概要 | display_name | DisplayNameオブジェクト | ||
運行状態 | condition | 文字列 | 以下の文字列が入ります - 運転見合わせ - 運転再開 - 列車遅延 - 運転状況 - 平常運転 - 工事に伴う運転変更 - その他 |
|
運行情報のステータス | status | 文字列 | 以下の文字列が入ります - 新規 - 続報 - 訂正 |
|
運行情報の要約 | summary | 文字列 | ||
運行情報の詳細 | detail | 文字列 | ||
影響路線情報 | links | InfluenceLinkオブジェクト | ○ | 出力順は不定 |
運行情報のステータス及びスレッドIDについて
運行情報のステータスが示す内容は以下の通りです。
・新規:最初に発信される情報 (第1報)
・続報:新規報配信のあとで、更新された情報 (第2報) です。(例:「新規」運転見合わせ → 「続報」運転再開)
新規報を上書きで更新する内容であり、第3報以降はすべて続報になります。
・訂正:「続報」と同じく新規報を更新する第2報以降を表しますが、情報を訂正する場合に使用されます。
※また、新規報以降は全て同一のスレッドIDで配信されます
DisplayNameオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
路線名称 | link | 文字列 | ||
影響範囲 | sections | DisplaySectionオブジェクト | ○ | 出力順は不定 |
DisplaySectionオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
開始ノード名称 | start | 文字列 | ||
終了ノード名称 | goal | 文字列 | ||
経由ノード名称 | via | 文字列 |
InfluenceLinkオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
路線情報 | link | Linkオブジェクト | ||
鉄道会社情報 | company | Companyオブジェクト | ||
区間情報 | sections | RailSectionオブジェクト | ○ |
Linkオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
路線のID | id | 文字列 | ||
路線の名称 | name | 文字列 | ||
運行路線の推奨色 | color | 文字列 |
Companyオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
鉄道会社ID | id | 文字列 | ||
鉄道会社の名称 | name | 文字列 |
RailSectionオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
開始ノード | from | Nodeオブジェクト | ||
終了ノード | to | Nodeオブジェクト | ||
進行方向 | direction | 文字列 |
Nodeオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
駅のノードID | id | 文字列 | ||
駅の名称 | name | 文字列 |
レスポンス例
"items" : [
{
"id": "00000009582094",
"thread_id": "00000009582094",
"date": "2020-06-17T17:20:00+09:00",
"display_name": {
"link": "八高川越線"
},
"condition": "列車遅延",
"status": "新規",
"summary": "高麗川~武蔵高萩駅間で線路内点検を行った影響で、一部列車に遅れが出ています。",
"detail": "高麗川~武蔵高萩駅間で線路内点検を行った影響で、一部列車に遅れが出ています。",
"links": [
{
"link": {
"id": "00000166",
"name": "JR川越線",
"color": "#00B48D"
},
"company": {
"id": "00000004",
"name": "JR東日本"
},
"sections": [
{
"from": {
"id": "00005189",
"name": "川越"
},
"to": {
"id": "00002645",
"name": "高麗川"
},
"direction": "down",
}
]
},
]
},
]