定期情報の更新判定ステータスコード

駅や路線は、名称変更や廃止があるため、定期情報の更新が必要になることがあります。
定期券利用時の運賃計算において、定割情報の更新判定ステータスコードを確認することで、
指定した定期情報に更新の必要があるかどうか、必要がある場合はその理由を知ることができます。

定期情報の更新判定ステータスコードについて

定期情報の更新判定ステータス 更新の必要性
0 更新の必要がない。 -
1 定期経路文字列の駅名が旧名称になっている。 推奨
2 定期経路文字列の駅名が見つからない。 必須
3 定期経路文字列の路線名が旧名称になっている。 推奨
4 定期経路文字列の路線名が見つからない。 推奨
5 定期経路文字列の駅名もしくは路線名の廃止など。 必須
6 定期経路シリアライズデータが不正な値。 必須

更新の必要性について

基本的には、定期情報の更新判定ステータスコードが0以外の場合は更新が必要となります。
ただし、更新が必須な場合と、早めの更新が推奨される場合があります。

更新が必須な場合

定期経路文字列の駅名が不正な値、駅名や路線名が廃止された値などの場合、
また、定期経路シリアライズデータが不正な値の場合、
定期情報から定期経路を再現できないため、控除計算が行われません。

更新が推奨される場合

定期経路文字列の路線名が不正な値の場合、意図しない定期経路として控除計算されてしまう可能性があります。
定期割り当てステータスコード0: 正常に定期経路が割り当てられた。 だとしても、 定期情報は更新することを推奨いたします。

また、駅名や路線名は、鉄道事業者もしくは「駅すぱあと」により名称変更されることがあります。
定期経路文字列の駅名や路線名が旧名称になっている場合は、内部的に新名称に置き換えて処理を行いますが、
もう一度名称変更があると新名称への置き換えができなくなるため、早めの更新を推奨いたします。

定期情報の更新について

定期情報の更新判定ステータスコードを利用して、利用者に定期経路の再登録を促すなど、アプリケーション側で常に最新の定期情報を保持できる仕組みを作ることをおすすめいたします。
詳しくは定期情報の更新をご確認ください。