「前後のダイヤ探索」機能で、指定した区間以降のみの経路にすることができるようになりました

こんにちは、駅すぱあと API 開発チームです。

この度「駅すぱあと API」では、「前後のダイヤ探索」機能において、指定した区間以降のみ経路を返すことができるようになる機能をリリースしました。

「前後のダイヤ探索」機能は、指定した区間に対して前後の時刻にある経路を取得することができる機能です。今回のアップデートでは、指定より前の区間の表示を取り除くことができるようになります。乗り換え案内サービスにおいて、すでに移動した区間は不要で、これから移動する区間のみを表示したい、といったケースで利用することができます。

アップデート内容について

「前後のダイヤ探索」機能に、sectionIndexで指定した区間より前の区間を取り除くパラメータが追加されます。

対象機能
- 前後のダイヤ探索（/search/course/pattern）
リクエストパラメータ
- trimBeforeSection
  sectionIndexで指定した区間より前の区間をレスポンスから取り除きます。省略可。
  - 指定できる値:
    - true: 指定した区間以降のみを返す
    - false: 経路全体を返す
    - 初期値: false

具体例

元の経路とパラメータの設定によって、どの様になるかを説明します。

元の経路が以下の様な形式であったとします。

A駅--区間1--B駅--区間2--C駅--区間3--D駅

今回のtripBeforeSectionパラメータをtrueにした場合に、sectionIndexパラメータの設定によって以下のようになります。

# sectionIndex=1 かつ trimBeforeSection=true
A駅--区間1--B駅--区間2--C駅--区間3--D駅

# sectionIndex=2 かつ trimBeforeSection=true
B駅--区間2--C駅--区間3--D駅

# sectionIndex=3 かつ trimBeforeSection=true
C駅--区間3--D駅

このように、指定した区間より前の経路が取り除かれることで、経路の必要となる部分のみを残すことができるようになります。

また、サービスやアプリケーション側で経路表示を加工することとは違い、運賃や料金といった金額が正しく計算されるようになり、経路シリアライズデータを指定する別の機能を利用することができるようになります。