駅すぱあと API BLOG

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

定期券の区間変更時の払い戻し計算が便利に

定期券 アップデート情報 通勤費

みなさんこんにちは。
本日のアップデートで、定期券の区間変更時の払い戻し計算式への対応の判定が可能となりました！

 

区間変更時の定期券の払い戻し

引っ越しや異動で手持ちの定期券が不要になった際に、各鉄道会社の窓口で定期券の払い戻しを行いますよね。
駅すぱあとWebサービスでも定期券の払い戻し計算に対応しており、主に通勤費管理システムで活用されています。
定期券の払い戻しには大きく分けて二つの方法を用意している鉄道会社が多いです。

1. 解約時の払い戻し →定期券が不要になった場合の払い戻しです。いわゆる「払い戻し」ですね。
2. 区間変更時の払い戻し →転勤などで、同一鉄道会社内の区間変更が可能な場合、「解約時の払い戻し」よりも少しお得に払い戻しが行えます。区間変更の可否については、鉄道会社ごとに条件が定められています。

この時、一部の鉄道会社では区間変更時の払い戻しに対応していないことがあることに注意が必要です
そこで今回のアップデートでは、定期券の払い戻し計算APIのレスポンスに、定期券の払い戻し時に区間変更としての計算が可能かを判定するためのデータが追加されます。

仕様、利用方法

定期券の払い戻し計算APIのレスポンスに、ResultSet/RepaymentList/RepaymentTicket/changeableSectionという値が付与されます。
こちらの値を参考に、changeSectionパラメータで区間変更時の計算式を適用するかどうかを指定することができるようになりました。

区間変更に対応している例

区間変更に対応している、JRさんの経路（高円寺ー新宿）では、changeableSectionの値はtrueとなります。

$ curl "https://api.ekispert.jp/v1/json/course/repayment?key=xxx&changeSection=true&serializeData={該当区間の経路シリアライズデータ}&checkEngineVersion=false"



区間変更に対応していない例

区間変更に対応していない鉄道会社さんは例えば名古屋鉄道さんが挙げられます。
神宮前ー金山(愛知県)の定期経路では、changeableSectionの値がfalseとなり、区間変更ができないことを表します。

$ curl "https://api.ekispert.jp/v1/json/course/repayment?key=xxx&serializeData={該当区間の経路シリアライズデータ}&checkEngineVersion=false"

 

ドキュメントでさらに詳しく説明しています！

駅すぱあとWebサービスを使い始めるには？

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