駅すぱあと API BLOG

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

コミュニティバスの利用を抑制できるようになりました

f:id:ekispert_api:20201201202220j:plain

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

この度「駅すぱあとWebサービス」では、駅情報の取得や経路探索においてコミュニティバスの利用を選択できる機能をリリースしました。

「駅すぱあと」では、路線バスとコミュニティバスは区別がされていません。そのため、交通種別で「路線バス」を選択したときには、路線バスだけでなく、コミュニティバスも含まれます。

今回リリースの機能では、駅情報の取得では、コミュニティバスのバス停を対象外としたり、経路探索では、コミュニティバスを利用する経路を対象外としたりすることができるようになります。

この機能は、法人向けの精算系サービスにおいて、定期券が存在しないことが多いコミュニティバスは移動手段から外したい、という要望が多く挙げられたことからリリースされました。

具体的には?

以下の機能に、コミュニティバスを抑制する communityBus というパラメータを追加しました。

  • 駅情報(/station)
  • 駅簡易情報 (/station/light)
  • 緯度経度からの周辺駅検索(/geo/station)
  • 住所情報からの周辺駅検索(/address/station)
  • 探索条件生成(/toolbox/course/condition)

communityBus パラメータに指定できる値は2つで、 contain (デフォルト)を指定するとコミュニティバスを含み、 except を指定するとコミュニティバスを対象外とすることができます。

今回は、駅情報(/station)と経路探索時に適用する探索条件生成(/toolbox/course/condition)での利用ケースを紹介します。

まず、駅情報(/station)のケースです。

例として、「立川駅南口」という名称から始まる駅を取得したとします。
リクエストは以下のようになります。

https://api.ekispert.jp/v1/xml/station?key=アクセスキーを入力してください&name=立川駅南口

結果として、以下の駅情報を取得することができます。

立川駅南口/西武バス
立川駅南口/立川バス
立川駅南口/東京都立川市

「立川駅南口/東京都立川市」は、コミュニティバスのバス停になり、結果にコミュニティバスが含まれていることがわかります。

ここからコミュニティバスのバス停を対象外する場合には、 communityBus パラメータに except を指定します。
リクエストは以下のようになります。

https://api.ekispert.jp/v1/xml/station?key=アクセスキーを入力してください&name=立川駅南口&communityBus=except

結果として、以下の駅情報を取得することができ、コミュニティバスのバス停は含まれません。

立川駅南口/西武バス
立川駅南口/立川バス

また、緯度経度からの周辺駅検索(/geo/station)、住所情報からの周辺駅検索(/address/station)の機能でも、同様の形でコミュニティバスのバス停を対象外にすることができます。

次に、経路探索のケースです。

コミュニティバスを対象外とした経路探索をしたい場合には、探索条件生成(/toolbox/course/condition)を利用します。

探索条件生成でコミュニティバスを対象外にする場合にも、 communityBus パラメータに except を指定します。
リクエストは以下のようになります。

https://api.ekispert.jp/v1/xml/toolbox/course/condition?key=アクセスキーを入力してください&communityBus=except

結果として、以下のような探索条件を表す文字列を取得することができます。

T32212332323192:F3321122120000:A23121141:

経路探索(/sear/course/extreme)に適用するため、上記で生成した探索条件の文字列を conditionDetail パラメータに設定します。

例として、昭島駅から武蔵砂川駅までの経路を探索します。
リクエストは以下のようになります。

https://api.ekispert.jp/v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=昭島:武蔵砂川&date=20201102&time=1240

結果として、以下の経路が返ります。

1. 昭島 - JR中央・青梅線 - 拝島 - 西武拝島線急行 - 武蔵砂川
2. 昭島 - 徒歩 - 昭島駅北口/東京都立川市 - 東京都立川市・くるりんバス - 西武立川駅南口/東京都立川市 - 徒歩 - 西武立川 - 西武拝島線急行 - 武蔵砂川
3. 昭島 - 徒歩 - 昭島駅北口/立川バス - 立川バス - 西武立川駅南口/立川バス - 徒歩 - 西武立川 - 西武拝島線急行 - 武蔵砂川
4. 昭島 - 徒歩 - 昭島駅南口/東京都昭島市 - 東京都昭島市・Aバス - 拝島駅東/東京都昭島市 - 徒歩 - 拝島 - 西武拝島線 - 武蔵砂川
5.  昭島 - 徒歩 - 昭島駅南口/東京都昭島市 - 東京都昭島市・Aバス - 拝島駅/東京都昭島市 - 徒歩 - 拝島 - 西武拝島線急行 - 武蔵砂川

2つめ、4つめ、5つめの経路で、コミュニティバスを利用していることがわかります。
ここからコミュニティバスを含む経路を対象外にする場合には、 conditionDetail パラメータに先程生成したコミュニティバスを対象外とする探索条件を設定します。
リクエストは以下のようになります。

https://api.ekispert.jp/v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=昭島:武蔵砂川&date=20201102&time=1240&conditionDetail=T32212332323192:F3321122120000:A23121141:

結果として、以下の経路が返るようになり、コミュニティバスを含む経路は含まれていません。

1. 昭島 - JR中央・青梅線 - 拝島 - 西武拝島線急行 - 武蔵砂川
2. 昭島 - 徒歩 - 昭島駅北口/立川バス - 立川バス - 西武立川駅南口/立川バス - 徒歩 - 西武立川 - 西武拝島線急行 - 武蔵砂川
3. 昭島 - JR青梅線 - 拝島 - 西武拝島線急行 - 武蔵砂川
4. 昭島 - JR中央・青梅線 - 拝島 - 西武拝島線 - 武蔵砂川
5. 昭島 - 徒歩 - 昭島駅北口/立川バス - 立川バス - 西武立川駅入口/立川バス - 徒歩 - 西武立川 - 西武拝島線 - 武蔵砂川

また、コミュニティバスを対象外とした経路を元に、前後のダイヤ探索(/search/course/pattern)や、経路の再現(/course/edit)での1本前、1本後で経路を取得した場合にも、コミュニティバスを対象外とした経路になります。

注意点

注意点として、コミュニティバスを対象外とするときは、交通手段として路線バスを有効にしていることが必要になります。

駅すぱあとでは、コミュニティバスは路線バスに含まれています。そのため、コミュニティバスを対象外とする上で、そもそも利用する交通種別に路線バスが設定されていることが前提となります。

駅情報などでは type パラメータ、探索条件生成では localBus パラメータで、交通種別に路線バスを含むかの設定ができます。

おわりに

今回の機能はコミュニティバスに焦点を当てた機能になります。
交通費や通勤費などを確認する精算系サービスで、ぜひご利用をご検討ください。
最後に、今回機能追加をしたAPIのドキュメントを以下に記載しますので、よろしければご覧ください。


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

ekiworld.net