コンテンツにスキップ

ダイヤ改正/運賃改定情報取得

/transport_revision [GET]

基本情報

概要

各公共交通機関のダイヤ改正、及び運賃改定の情報を取得します。
会社IDや路線ID等を用いて、特定の情報に絞り込むことができます。

URL

https://{HOST}/{CID}/v1/transport_revision

出力形式

  • JSON

対応言語

  • ja

出力順

  • データ登録日降順

※弊社で登録した最新の情報から出力されます。
　改正日や反映日順ではありませんのでご注意ください。

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
company 交通機関会社ID 文字列 ピリオド区切りで複数指定できます
link 路線ID 文字列 ピリオド区切りで複数指定できます
type 出力する交通機関 文字列 交通機関タイプより指定 ピリオド区切りで複数指定できます
出力する改正情報の種別を限定したい場合にご利用ください
未指定の場合は全種別で検索されます

指定可能な項目はこちらをご覧ください
revision_type 出力する改正情報 文字列 timetable：ダイヤ改正情報
fare：運賃改定情報		 ピリオド区切りで複数指定できます
未指定の場合は全種別で検索されます
status 改正状況 文字列 planning：改正日未定
scheduled：改正日確定
fixed：改正内容反映済み		 改正日の確定状況で絞り込みが可能です
ピリオド区切りで複数指定できます

・planningおよびscheduledは、各交通機関会社が定める改正日の状況を示します
・fixedは、改正内容がNAVITIME APIに反映されていることを示します
schedule_date_from 改正予定日絞り込み(開始) 文字列(日付)
YYYY-MM-DD
schedule_date_to 改正予定日絞り込み(終了) 文字列(日付)
YYYY-MM-DD
offset データの出力開始位置 数値 0 最小値：0
最大値：2000		 何件目から表示されるか（1件目が0）を指定します
limit データの出力件数 数値 10 最小値：1
最大値：100
all 全件出力 真偽値 false true：全件出力する
false：全件出力しない		 limit及びoffsetとの併用は不可
company_filter 利用対象外交通機関情報の非表示設定 真偽値 false true：利用設定外交通機関情報を非表示にする
false：全ての交通機関情報を表示する		 利用設定されていない交通機関の情報の表示有無を指定します

type（交通機関タイプ）

'type' は以下の文字列を取り得ます。

文字列 概要
train 鉄道
ultraexpress_train 鉄道（特急）
superexpress_train 新幹線
local_bus 路線バス
highway_bus 高速バス
shuttle_bus シャトルバス
community_bus コミュニティバス
ferry フェリー
cable_railway ケーブルカー/ロープウェイ

パラメータ構成例

  • 鉄道データで、NAVITIME APIに反映済みの改正情報を検索
/transport_revision?type=train&status=fixed

レスポンス

名称 レスポンス名 型名 配列 Nullable 説明
検索数 count Countオブジェクト nullable
改正情報 items TransportRevisionオブジェクト 〇

Countオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 nullable オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 nullable データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

TransportRevisionオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
対象の交通機関会社情報 company Companyオブジェクト
対象の路線情報 link Linkオブジェクト nullable 路線別の改正情報の場合に出力
交通機関の種別 type 文字列 交通機関タイプのいずれかが入ります
改正情報の種別 revision_type 文字列 timetable：ダイヤ改正情報
fare：運賃改定情報
改正内容の見出し title 文字列 nullable データが存在する場合のみ出力
改正内容 message 文字列 nullable データが存在する場合のみ出力
改正日に関する情報 revision_date RevisionDateオブジェクト nullable

title, messageのテキスト情報について

テキストが長文になる場合、文中に改行を示す <br> タグが出力されるケースがございます。
サービス上で表示する際などにご活用ください。

Companyオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
交通機関会社ID id 文字列
交通機関会社の名称 name 文字列
名称 レスポンス名 型名 配列 Nullable 説明
路線ID id 文字列
路線名称 name 文字列

RevisionDateオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
改正予定日 schedule_date 文字列 各交通機関会社が提示する改正予定日
改正状況 status 文字列 planning：改正日未定
scheduled：改正日確定
fixed：改正内容反映済み
APIへの反映日 update_date 文字列 nullable NAVITIME APIへの改正内容反映日

update_dateについて

statusがfixedのほか、scheduledの場合も出力されます。ただし、scheduledの場合、1週間以上先の日付は入りません。
また、対応状況によってはfixedのみしか更新されない場合がございますのでご了承ください。

レスポンス例

{
    "count": {
        "total": 7,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "company": {
                "id": "00000048",
                "name": "広島電鉄"
            },
            "link": {
                "id": "00000345",
                "name": "広島電鉄宮島線"
            },
            "type": "train",
            "revision_type": "fare",
            "title": "2022/11/1 運賃改定",
            "message": "2022/11/1より、運賃改定が実施されます。",
            "revision_date": {
                "schedule_date": "2022-11-01",
                "update_date": "2022-10-24",
                "status": "fixed"
            }
        },
        ・・・
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス エラーメッセージ 発生理由
405 This http method is invalid : POST (等) 許可されていないHTTPメソッドでアクセスされた場合に発生します。
400 parameter error: company: ['min length is 1'] company に空文字を指定した場合に発生します。
400 parameter error: link: ['an invalid code: {value}'] link にピリオド区切りで不正な路線IDを指定した場合に発生します。
400 parameter error: type: ['an invalid item: {value}'] type にピリオド区切りで交通機関タイプ以外の不正な値を指定した場合に発生します。
400 parameter error: revision_type: ['an invalid item: {value}'] revision_type にピリオド区切りで timetable, fare 以外の不正な値を指定した場合に発生します。
400 parameter error: status: ['an invalid item: {value}'] status にピリオド区切りで planning, scheduled, fixed 以外の不正な値を指定した場合に発生します。
400 parameter error: schedule_date_from: ['an invalid date: {value}']
parameter error: schedule_date_from: ['not date format : {value}']		 schedule_date_from が YYYY-MM-DD 形式でない、または日付として存在しない値を指定した場合に発生します。
400 parameter error: schedule_date_to: ['an invalid date: {value}']
parameter error: schedule_date_to: ['not date format : {value}']		 schedule_date_to が YYYY-MM-DD 形式でない、または日付として存在しない値を指定した場合に発生します。
400 parameter error: offset: ['min value is 0']
parameter error: offset: ['max value is 2000']		 offset に 0〜2000 の範囲外の値を指定した場合に発生します。
400 parameter error: offset: ["field 'offset' cannot be coerced: invalid literal for int() with base 10: '{value}'"] offset に数値変換できない値を指定した場合に発生します。
400 parameter error: limit: ['min value is 1']
parameter error: limit: ['max value is 100']		 limit に 1〜100 の範囲外の値を指定した場合に発生します。
400 parameter error: limit: ["field 'limit' cannot be coerced: invalid literal for int() with base 10: '{value}'"] limit に数値変換できない値を指定した場合に発生します。
400 parameter error: all: ['unallowed value {value}'] all に true, false 以外の不正な値を指定した場合に発生します。
400 parameter error: all: ["'limit', 'offset' must not be present with 'all'"] all と limit / offset を同時に指定した場合に発生します。
400 parameter error: company_filter: ['unallowed value {value}'] company_filter に true, false 以外の不正な値を指定した場合に発生します。
400 invalid date term schedule_date_to に schedule_date_from より前の日付を指定した場合に発生します。
400 bad usage on this contract　:　invalid company company_filter=true 指定時に、契約で利用可能に設定されていない交通機関会社ID、または利用不可に設定されている交通機関会社IDを company に指定した場合に発生します。
400 bad usage on this contract　:　use_company and unuse_company must be either. company_filter=true 指定時に、利用可能交通機関会社と利用不可交通機関会社の両方が設定されている場合に発生します。