定期割り当てステータスコード

定期券利用時の運賃計算では、探索経路に対して指定された定期経路を割り当て、
正常に割り当てることができると、定期区間の運賃を控除した結果が返ります。
この時、定期割り当てステータスコードを確認することで、
探索結果の経路毎に、定期経路を割り当てられたかどうか、割り当てられない場合はその理由を知ることができます。

定期割り当てステータスコードについて

値	定期割り当てステータス
0	正常に定期経路が割り当てられた。
1	定期券を利用しても運賃が変わらない、または高くなってしまう。
2	定期区間を含む経路ではない。
3	割引乗車券が含まれる経路のため、定期区間の控除計算ができない。
4	定期情報から定期経路を再現できない。
99	予期しない理由により定期経路が割り当てられない。（値に99が返された場合は、info@val.co.jp までフィードバックをお寄せください）

※ 定期割り当てステータスコードが0以外の場合は、定期区間の運賃は控除されていません。

定期情報から定期経路を再現できない場合

定期情報の更新判定ステータスコードを確認することで、定期経路を再現できない理由を知ることができます。

オフピーク定期券を利用する場合

経路探索や経路の再現／定期券・指定列車利用において、addAssignStatus=trueおよびoffpeakTeikiMode=peakTimeを指定した場合、探索経路と定期券の経路の組み合わせによっては、一部の定期券区間は控除され、別の一部の定期券区間は「オフピーク定期券をピーク時間帯に利用した」ことを理由に控除されないようなケースがあります。このとき、定期割り当てステータスに「0: 正常に定期経路が割り当てられた」が返ります。

また、全部の定期券区間が「オフピーク定期券をピーク時間帯に利用した」ことを理由に控除されない場合は、定期割り当てステータスに「2: 定期区間を含む経路ではない」が返ります。 addAssignStatus=trueではなくbringAssignmentError=trueを指定している場合には、エラーレスポンスが返ります。