「オフピーク定期券(控除計算)」に対応しました
平素、「駅すぱあとWebサービス」をご愛顧いただき、誠にありがとうございます。
この度「駅すぱあとWebサービス」では、JR東日本より発売されているオフピーク定期券について、オフピーク定期券での定期券利用時の運賃計算に対応しました。
なお、「駅すぱあとWebサービス」をご契約中の皆さまにはご登録のメールアドレスまで詳細なご案内をお送りしておりますので、あわせてご確認ください。
※オフピーク定期券につきましてはJR東日本 公式サイトをご覧ください。
※2023年2月27日に対応済の「オフピーク定期券(金額取得・払い戻し)」につきましてはこちらのご案内をご覧ください。
対応日
2023年8月25日(金)
※「エンタープライズプラン(オンプレミス版)」は「2023年9月1版」(2023年8月25日)
対応内容
オフピーク定期券利用時の運賃計算方法を指定するパラメータが新規に追加されます。
■ 対象機能
・経路探索(/search/course/extreme)
・経路の再現/定期券・指定列車利用(/course/edit)
■ 追加パラメータ
〇パラメータ名:offpeakTeikiMode
〇値
・offpeakTime:オフピーク時間帯の利用とみなして運賃計算する
・peakTime:ピーク時間帯の利用とみなして運賃計算する
〇説明:
オフピーク定期券利用時の計算モード。
assignRoute, assignDetailRoute, assignTeikiSerializeDataのいずれか指定時のみ指定可。
省略可。省略時は、指定された定期券の種類に関わらず、通常の定期券利用時の運賃計算となります(オフピーク定期券として扱われません)。
※詳しくは定期券利用時の運賃計算 > 定期情報を「オフピーク定期券」として利用する場合および定期割り当てステータスコード > オフピーク定期券を利用する場合をご確認ください。
機能詳細や詳しい活用方法、本機能に対応したGUIのサンプルプログラムについて、「駅すぱあとWebサービス」の開発チームのブログにてご案内しております。以下ボタンよりぜひご覧ください。
注意事項
・「駅すぱあとWebサービス」では、保存された定期情報が通常の定期券かオフピーク定期券かに関わらず、offpeakTeikiModeパラメータが指定された場合は、「オフピーク定期券」とみなします。
・オフピーク定期券として「定期券利用時の運賃計算」を行う場合は、現在ご利用の定期券情報をそのままご利用いただけます。
・取得した定期券の情報が、通常の定期券/オフピーク定期券かを区別しておきたい場合には、お客様のアプリケーション側で独自に値を保持するなどの必要があります。
影響範囲
本機能対応による追加パラメータは省略可能であり、未指定時はオフピーク定期券として扱わず、通常の控除と同じとなります。
そのため、お客様側のプログラムへの影響はございません。
※プラン別でのご利用可否は下表をご参照ください。
機能の利用可否 | 機能追加の影響 | |
---|---|---|
スタンダードプラン | 可 | なし |
エンタープライズプラン | 可 | なし |
フリープラン | 不可 | なし |
関連リンク集
■ 関連ドキュメント
オフピーク定期券(Dictionary)
定期券利用時の運賃計算 > 定期情報を「オフピーク定期券」として利用する場合
定期割り当てステータスコード > オフピーク定期券を利用する場合
■ 駅すぱあとWebサービス 開発チームブログ
オフピーク定期券利用時の運賃計算に対応しました
■ GUIサンプル(経路表示パーツ)
https://github.com/EkispertWebService/GUI/wiki/html5_reference_Course