駅すぱあと API BLOG

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

経路探索結果にダイヤに関する注釈や備考のコメントを追加しました

f:id:ekispert_api:20210519222003j:plain

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

「駅すぱあとWebサービス」では、路線バスのダイヤに対して注意が必要な場合(お盆ダイヤのため通常と異なる運行になる、など)はコメントを出しておりましたが、この度、路線バス以外の交通機関でもダイヤ探索の経路結果に、ダイヤに関する注釈や備考をコメントとして返すようになりました。

具体的には?

ダイヤに関する注釈や備考の具体例として、特定の日に限り運行している、または、運休している、といった内容や、特定の車両などが有料のシートになっているといった内容などがあります。

今回はダイヤによる探索の経路結果を返す機能の、区間に対応したコメントを返す要素に、ダイヤに関する注釈や備考のコメントが、路線バス以外の交通機関でも返るようになります。

対象となる機能は以下のとおりです。

  • 経路探索(/search/course/extreme) ※ searchType=plain指定時を除く
  • 経路簡易探索(/search/course) ※ searchType=plain指定時を除く
  • 前後のダイヤ探索(/search/course/pattern)
  • 経路の再現/定期券・指定列車利用(/course/edit)
  • 探索結果の運賃切り替え(/course/recalculate) ※addRouteData=true指定時のみ

また、区間に対応したコメントを返す要素は、以下のレスポンスのパスになります。

ResultSet / Course / Route / Line / Comment

コメントには、文言と合わせてコメントの種別も返ります。こちらは「attention」という種別になります。 コメントの種別は、以下のレスポンスのパスになります。

ResultSet / Course / Route / Line / Comment / type

以下は、ダイヤに関する注釈や備考のコメントが返る場合のレスポンスのサンプルになります(レスポンスの一部を抜粋しています)。

<Route index="1" ...>
    <Point index="1">
        <Station code="1071046">
            <Name>アイーナ前/岩手県北バス</Name>
        </Station>
    </Point>
    <Line index="1" ...>
        <Name>岩手県北バス・アイーナ前-盛岡大学・盛岡大学行</Name>
        <!-- Commentは、複数件返る場合があります。 -->
        <Comment type="attention">休校日は運休</Comment>
        <Comment type="attention">このバス会社の季節ダイヤは準備中のため、参考情報としてご利用ください</Comment>
    </Line>
    :
    <Line index="3" ...>
        <Name>IGRいわて銀河鉄道・八戸行</Name>
        <!-- ダイヤに注釈・備考がなければCommentは返りません -->
    </Line><Line index="5" ...>
        <Name>岩手県北バス・イコオSC-上小友・上小友行</Name>
        <!-- Commentが1件返る場合 -->
        <Comment type="attention">このバス会社の季節ダイヤは準備中のため、参考情報としてご利用ください</Comment>
    </Line>
    <Point index="6">
        <Station code="1071691">
            <Name>間沢/岩手県北バス</Name>
        </Station>
    </Point>
</Route>

路線バスのダイヤ対応状況の注意喚起コメントとの違いについて

以下の記事でも案内していますが、過去に路線バスのダイヤ対応状況についての注意喚起情報をコメントで返す機能をリリースしています。

blog.ekispert.com

「路線バスのダイヤ対応状況の注意喚起コメント」では、路線バスについてのみの案内となっていましたが、今回のダイヤに関する注釈や備考については、すべての交通種別(鉄道、路線バス、高速・連絡バス、空路、海路)が対象になります。

また、共通する点として、コメントが返るレスポンスのパスは同様のため、既に路線バスのコメントに対応している場合は、追加対応は不要となります。

ResultSet / Course / Route / Line / Comment

注意点

ダイヤに関する注釈や備考のコメントについての注意点は以下になります。

1. コメントの末尾に句点(。)は付きません
2. コメントが複数返ることがあります。

レスポンスに返されるダイヤに関する注釈や備考のコメントには、末尾の句点(。)は付きません。また、コメントが複数返ることがあります。

そのため、サービスやアプリケーションに表示する際に、複数のコメントを結合したい場合には、サービスやアプリケーション側で、句点(。)を付ける等の工夫をお願いします。

おわりに

これから、新型コロナウイルス(COVID-19)の影響により、急なダイヤ内容の変更が発生することも考えられます。

「駅すぱあと」として、常に最新のダイヤに対応していきますが、どうしても対応が間に合わない場合にはコメントによる対応を取らせていただく場合があります。

今回の対応により、そのようなケースについてのコメントが返るようになりますので、ぜひサービスやアプリケーションでの利用をご検討いただければと思います。


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

ekiworld.net