グリーン定期や二区間定期券の対象区間が判定できるようになりました

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

この度「駅すぱあとWebサービス」では、経路探索結果において、定期券で利用できる車両、定期券の種類（二区間定期など）の情報に対して、対象となる区間を判定する情報を追加するアップデートを行いました。

定期券の車両や種類について

定期券の情報には、定期代の他にも以下の情報が存在します。

定期券で利用できる車両
定期券の種別

定期券で利用できる車両の例として、グリーン車の利用ができるグリーン定期券があります。駅すぱあとWebサービスでは、グリーン定期券などの定期券が利用できる車両の情報が経路に存在する場合、「ResultSet / Course / PassStatus / kind」に vehicle という値が設定された「ResultSet / Course / PassStatus」が返ります。

定期券の種別の例として、鉄道事業者の全線を利用できる全線定期券があります。駅すぱあとWebサービスでは、全線定期券などの特殊な定期券種別の情報が経路に存在する場合、「ResultSet / Course / PassStatus / kind」に nikukanteiki または、 bycorporation という値が設定された「ResultSet / Course / PassStatus」が返ります。

以下の図は、「秋葉原ー横浜」の経路で、グリーン定期券と全線定期が存在する例になります。

※参考画像は「駅すぱあと（Windows）」となります。「駅すぱあとWebサービス」では画面の提供はありません。

また、定期券が利用できる車両の情報や、特殊な定期券の種別の情報が存在しない、一般定期の情報しか存在しない場合には、「ResultSet / Course / PassStatus」は返りません。

定期券の種類については、Webドキュメントでも説明していますので、よろしければご覧ください。

docs.ekispert.com

具体的には？

経路探索の結果を取得する際に、経路探索結果に定期券で利用できる車両、または、定期券の種類の情報が存在する場合、定期券の状態を表す要素（ResultSet / Course / PassStatus）がレスポンスに返ります。

この定期券の状態に対して、対象となる区間を表す、区間開始インデックスと区間終了インデックスの値が追加されます。

区間インデックスについては、Webドキュメントでも説明していますので、よろしければご覧ください。

docs.ekispert.com

追加されるレスポンスパラメータは以下のとおりです。

ResultSet / Course / PassStatus / fromLineIndex : 対象となる区間の開始区間インデックス
ResultSet / Course / PassStatus / toLineIndex ：対象となる区間の終了区間インデックス

以下は、レスポンスのサンプル（XML形式）になります。

:
  <!-- PassStatusにfromLineIndexとtoLineIndexの値が追加されます。--> 
  <PassStatus toLineIndex="2" fromLineIndex="2" teiki3Index="2" teiki6Index="2" kind="bycorporation" index="1" selected="true" teiki1Index="2">
    <Name>一般定期</Name>
    <Type>Normal</Type>
    <Comment />
  </PassStatus>
  <PassStatus toLineIndex="2" fromLineIndex="2" teiki3Index="2" teiki6Index="2" kind="bycorporation" index="2" selected="false" teiki1Index="2">
    <Name>全線定期</Name>
    <Type>Zensen</Type>
    <Comment />
  </PassStatus>
  <PassStatus toLineIndex="3" fromLineIndex="3" teiki3Index="3" teiki6Index="3" kind="vehicle" index="3" selected="true" teiki1Index="3">
    <Name>普通</Name>
    <Type>Normal</Type>
  </PassStatus>
  <PassStatus toLineIndex="3" fromLineIndex="3" teiki3Index="3" teiki6Index="3" kind="vehicle" index="4" selected="false" teiki1Index="3">
    <Name>グリーン</Name>
    <Type>Green</Type>
  </PassStatus>
:

これまでは、定期券を利用できる車両、定期券の種類の定期券の状態が、1つの定期区間に複数存在する場合、定期券の状態が経路のどの区間を対象とするかを判別することができませんでしたが、今回のアップデートにより判別できるようになります。