定期控除の機能がより便利に - 駅すぱあと API BLOG

みなさんこんにちは。
本日のアップデートで、 「定期割り当てステータス」と「定期情報の更新判定ステータス」 の二つの機能が追加されました！

定期券利用時の運賃計算

主に交通費精算サービスでは、従業員が所持している定期券を割り当てた運賃を算出するのが通例となっていますよね。

駅すぱあとWebサービスでは、定期経路シリアライズデータまたは定期経路文字列を利用することによって定期券を経路に割り当てることができるのですが、その定期経路シリアライズデータや定期経路文字列にすでに存在しない駅や路線が含まれていると、適切に運賃を算出できない可能性があります。
なので定期的に定期経路シリアライズデータまたは定期経路文字列の更新を推奨しているのですが、
今回のアップデートにより、経路ごとに定期区間が控除されたかどうか、さらに控除ができなかった場合には、その理由を確認できるようになりました🎉
また、定期情報に更新が必要な場合には、その理由が確認できるようになりました🎉🎉

仕様、利用方法

経路検索API /search/course/extremeと経路の再現／定期券利用API /course/editにて、addAssignStatusパラメータにtrueを渡すと、レスポンスにResultSet/Course/AssignStatus要素が付与されます。

高円寺-新宿の定期券を所持しており、高円寺-渋谷まで移動する例です。

$ curl "https://api.ekispert.jp/v1/xml/search/course/extreme?key=xxx&viaList=高円寺:渋谷&assignDetailRoute=高円寺:ＪＲ中央線快速:Up:新宿&addAssignStatus=true"

:
<AssignStatus requireUpdate="0" kind="teiki" code="0" /> 
:

高円寺-新宿間に定期経路が割り当たるので、code属性の値は、正常に定期経路が割り当てられた状態を表す「0」が返ります。
また、assignDetailRouteパラメータに正しい定期経路文字列が割り当てられているので、require update属性の値は、定期情報の更新の必要がない状態を表す「0」が返ります。

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