経路シリアライズデータ

経路探索結果の1経路を再現するための情報です。経路探索の結果から経路ごとに取得することができます。

経路シリアライズデータを利用すれば、出発駅や到着駅、探索条件などを個別に保持して再探索することなく経路を再現することができます。
自由席やグリーン席など座席種別を切り替えた運賃計算や、特定の区間を指定した列車に置き換える、などといった経路探索結果に対する操作を行いたい場合などにご利用いただけます。

経路の再現

経路シリアライズデータは、道筋(駅と路線の並び)を再現するために必要最低限の情報です。
時刻や料金については、経路シリアライズデータから経路を再現する時点でデータが変わっていれば、再現を保証するものではありません。なお、駅名や路線名が変更になった場合、新しい駅名と路線名で再現されます。

経路シリアライズデータの有効期限

「駅すぱあと API」のデータ更新の際にエンジンのバージョン(ResultSet / engineVersion)が変わりますが、 経路シリアライズデータ生成時のエンジンバージョンと、経路の再現時のエンジンバージョンが同一の場合は、時刻や料金を含め完全に同じ経路の再現が保証されます。
常に完全な再現を保証したい場合は、checkEngineVersionをtrueにすることで、同一エンジンバージョンでない場合にエラーを返すことができます。(未指定時はtrue)

逆に、データ更新によりエンジンバージョンが切り替わったタイミングの、同一エンジンバージョンでないことによるエラーを回避するためには、falseを指定していただくことも有効です。
経路シリアライズデータは保存して利用することも可能ですが、隣接する版もしくは長くても1ヶ月程度のごく短期間での利用をおすすめします。詳細は後述の注意点をご確認ください。

ダイヤによる探索結果の経路シリアライズデータの場合

鉄道の場合は、過去のダイヤや運賃データを原則として次の改定があるまで保持しているため、もう一度改定があるまでの間は同じ経路を再現することが可能です。
ただし、列車がなくなってしまった場合などは、完全に同じ経路ではなく、出発時刻が近い列車など似た経路として再現します。 なお、列車が変わると乗り換え駅が変わる可能性があります。

また、経路シリアライズデータには探索条件を保持していますが、探索条件に「有料特急を利用する」などの条件がある場合、 有料特急を利用する経路になってしまうと、金額が高くなる可能性もあります。

そのため、長くても1ヶ月程度のごく短期間で経路シリアライズデータを生成し直していただくことをおすすめします。

なお、鉄道以外(バスなど)は、基本的には改定前のデータを保持していないため、ダイヤや運賃が変わった場合は、最新のデータでの再探索結果となります。

平均待ち時間による探索結果の経路シリアライズデータの場合

基本的にはダイヤによる探索結果の場合と同様ですが、エンジンバージョンが変わっても同じ経路を再現できる可能性が比較的高くなります。
ただし、事業者による春のダイヤ改正など大きな変更があった場合は、経路シリアライズデータを生成し直していただく必要があるため、やはりごく短期間での利用をおすすめします。