駅すぱあと API BLOG

駅すぱあと APIの開発チームが作るブログです。

経路探索結果から前後のダイヤを調べる機能が便利になりました

f:id:ekispert_api:20210824174339p:plain

こんにちは、駅すぱあとWebサービス開発チームの山崎です。

この度「駅すぱあとWebサービス」では、経路探索結果からルートを変更せず、 前後のダイヤを見て乗りたい電車の選択ができる「前後のダイヤ探索」機能をアップデートしました。

docs.ekispert.com

今回は、そのアップデート内容を紹介します。

具体的には?

今回のアップデート内容は大きく3つです。

1. 前後のダイヤ探索結果の探索モードを選べるようになりました
2. 探索結果に情報を付加できるようになりました
3. 前後のダイヤ探索結果取得時に元となった経路が判定しやすくなりました

こちらのアップデート内容を1つずつ紹介していきます。

1. 前後のダイヤ探索結果の探索モードを選べるようになりました

従来の「前後のダイヤ探索」機能では、元となる探索結果が2区間以上で構成されている場合、2区間目以降の前後のダイヤを取得すると、前のダイヤは1区間目も合わせて変わりますが、後のダイヤは1区間目は同じ結果になります。

※ 経路の区間については、こちらをご参照ください

docs.ekispert.com

例として、以下の経路を前後のダイヤ探索の元の探索結果とします。

高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:12発)JR湘南新宿ライン(10:18着)--池袋

f:id:ekispert_api:20210907184555p:plain

2区間目の「新宿--JR埼京線--池袋」を区間指定し、前後のダイヤを2つずつ取得した結果は以下のようになります。

・2つ前のダイヤ
高円寺--(09:45発)JR中央線快速(09:52着)--新宿--(10:01発)JR埼京線(10:07着)--池袋

・1つ前のダイヤ
高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:06発)JR埼京線(10:12着)--池袋

・元のダイヤ
高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:12発)JR湘南新宿ライン(10:18着)--池袋

・1つ後のダイヤ
高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:15発)JR埼京線(10:20着)--池袋

・2つ後のダイヤ
高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:18発)JR埼京線(10:24着)--池袋

1つ後のダイヤ、2つ後のダイヤを見てもらうと分かる通り、2区間目の新宿駅の出発時間は後ろになっていますが、1区間目の高円寺の出発時間は10:00発のままになっています。

今回のアップデートでは、探索のモードを設定し、指定した区間より前の区間の時間も合わせて調整することができるようになりました。

探索のモードは、assignInstructionパラメータで指定することができ、従来の指定した区間以降の時間を調整する場合にはSearchAfterを設定し、指定した区間より前も時間も合わせて調整する場合にはSearchAllを設定します。

上記の例において、探索のモードにSearchAllを設定した場合の結果は以下のようになります。

・2つ前のダイヤ
高円寺--(09:45発)JR中央線快速(09:52着)--新宿--(10:01発)JR埼京線(10:07着)--池袋

・1つ前のダイヤ
高円寺--(09:52発)JR中央線快速(09:59着)--新宿--(10:06発)JR埼京線(10:12着)--池袋

・元のダイヤ
高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:12発)JR湘南新宿ライン(10:18着)--池袋

・1つ後のダイヤ
高円寺--(10:00発)JR中央線快速(10:06着)--新宿--(10:15発)JR埼京線(10:20着)--池袋

・2つ後のダイヤ
高円寺--(10:03発)JR中央線快速(10:11着)--新宿--(10:18発)JR埼京線(10:24着)--池袋

従来の結果と比べて、1つ前のダイヤ、2つ後のダイヤの1区間目が、2区間目に合わせて変わっていることがわかります。

このように、探索モードのassignInstructionパラメータを利用してもらうことで、指定した区間より後の区間の時間だけではなく、全体の区間の時間を調整した探索結果を取得することができるようになりました。

サービスやアプリケーションの用途に合わせてご利用ください。

2. 探索結果に情報を付加できるようになりました

「駅すぱあとWebサービス」の「経路探索」機能(/search/course/extreme)などで付加できていた、いくつかの情報を「前後のダイヤ」機能の探索結果にも付加できるようになりました。

  • resultDetail:路線に会社情報を付加します。
  • addChange:乗車位置情報を付加します。
  • addStop:区間ごとに停車駅一覧を付加します。

こちらのリクエストパラメータを利用してもらうことで、アプリケーションやサービスに「前後のダイヤ探索」の結果を表示する場合に、追加情報を合わせて表示することができるようになります。

3. 前後のダイヤ探索結果取得時に元となった経路が判定しやすくなりました

従来の「前後のダイヤ探索」機能では、探索結果を取得した場合に、どの経路が元の基準とした経路かを簡単に判定することができませんでした。

今回のアップデートでは、以下のレスポンスパラメータを新規に追加し、基準とした経路を簡単に判定できるようになりました。

ResultSet / Course / selected

※ selectedの値と説明は以下のとおりです。
true: 基準となる経路
false: 基準以外の経路

こちらのレスポンスパラメータを利用してもらうことで、アプリケーションやサービスで「前後のダイヤ探索」の結果を一覧で表示する場合などに、基準とした経路をハイライトして見やすくするなどの処理を簡単に行うことができるようになります。

おわりに

今回は「前後のダイヤ探索」機能のアップデート内容を紹介しました。

以下のリリース時の記事には、他の機能との違いや、注意点についての記載がありますので、ぜひ合わせてご覧ください。

blog.ekispert.com


駅すぱあとWebサービスを使ってみるには?

駅すぱあとWebサービス スタンダードプランは90日間無料でお試しできます。 こちらから申し込みして気軽に触ってみてください!

ekiworld.net