運賃が運賃改定に対応しているかを判定する

レスポンスの金額が運賃改定に対応しているかを、経路探索結果のResultSet / Course / Price / RevisionStatusの要素で判定することができます。

Attention!

本機能は、消費税率変更時の対応状況を表す機能となります。
通常の運賃改定時のための機能ではありませんので、ご注意ください。

RevisionStatusは、以下のいずれかの値を取ります。

値	説明
previous	運賃改定に未対応の金額
forecast	「駅すぱあと」が予測した運賃改定後の見込の金額を利用
latest	運賃改定に対応後の金額。 ※ もしくは、消費税率変更時に交通事業者が運賃改定を行わない場合の据え置きの金額

※ Windows版でのイメージ図

Attention!

運賃改定の状態（previous、forecast、latest）は、弊社のデータ更新により変化します。
見込運賃は、最新の改定に対応し、運賃改定後の金額になるにあたり、金額が変わる可能性があります。
精度等については見込の金額をご覧ください。
そのため、アプリケーション上で金額を表示する時には、「改定に未対応」「見込の金額」「最新の改定に対応済み」がユーザに分かりやすく伝わるように、実装することを推奨します。

なお、探索日を運賃改定日より前に指定して探索した場合、運賃の状態は指定した日付時点での状態になります。例として、2019年10月1日が運賃改定日で、2019年9月30日を探索日に指定した場合、2019年9月30日時点の運賃改定に対応していれば「最新の改定に対応済み」となるため、 latest が返ります。

手順

経路探索を行います。

※リクエスト例では日本語で記述しておりますが、リクエストパラメータに日本語が含まれる場合には、日本語の部分をUTF8でURLエンコード(パーセントエンコード)してください。

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=新宿:高円寺&searchType=plain

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201906_03a">
  <Course searchType="departure" dataType="onTimetable">
    <Route index="1" ...>
      <Point index="1">
        <Station code="23545">
          <Name>静岡</Name>
          <Type>train</Type>
          <Yomi>しずおか</Yomi>
        </Station>
        :
      </Point>
      <Line teiki3Index="1" chargeIndex="2" fareIndex="1" index="1" teiki1Index="1" ...>
        <Name>ＪＲ新幹線こだま</Name>
        <Type detail="shinkansen">train</Type>
        :
      </Line>
      <Point index="2">
        <Station code="25077">
          <Name>名古屋</Name>
          <Type>train</Type>
          <Yomi>なごや</Yomi>
        </Station>
        :
      </Point>
    </Route>
    <Price kind="ChargeSummary">
      <Oneway>2480</Oneway>
      <Round>4960</Round>
    </Price>
    <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Charge" index="2" ...>
      <Name>自由席</Name>
      <Type>Free</Type>
      <Oneway>2480</Oneway>
      <!-- 交通事業者の運賃改定への対応状況を表す要素 -->
      <RevisionStatus>latest</RevisionStatus>
      <Round>4960</Round>
    </Price>
    <Price kind="FareSummary">
      <Oneway>3350</Oneway>
      <Round>6700</Round>
    </Price>
    <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Fare" index="1" ...>
      <Type>Fare</Type>
      <Oneway>3350</Oneway>
      <!-- 交通事業者の運賃改定への対応状況を表す要素 -->
      <RevisionStatus>latest</RevisionStatus>
      <Round>6700</Round>
    </Price>
    <Price kind="Teiki1Summary">
      <Oneway>136200</Oneway>
    </Price>
    <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Teiki1" index="1" ...>
      <Type>Teiki1</Type>
      <Oneway>136200</Oneway>
      <!-- 交通事業者の運賃改定への対応状況を表す要素 -->
      <RevisionStatus>latest</RevisionStatus>
    </Price>
    :
  </Course>
</ResultSet>

ResultSet / Course / Price / Type が以下の値の場合に、ResultSet / Course / Price / RevisionStatusには、交通事業者の運賃改定への対応状況を表す値が返ります。

Fare
Charge
Teiki1
Teiki3
Teiki6
Teiki12

fareRevisionStatusをご利用の場合

Attention!

運賃改定の状態を表す項目として、ResultSet / Course / Price / fareRevisionStatusが存在しますが、「見込の金額」の状態を判定することができません。

fareRevisionStatusは引き続きご利用いただくことが可能ですが、これから開発を始める方はRevisionStatusをご利用いただくことを推奨します。

:
<!-- 運賃改定の状態を表す属性(fareRevisionStatus) -->
<Price fareRevisionStatus="salesTaxRateIsNotSupported" toLineIndex="1" fromLineIndex="1" kind="Fare" index="1" ...>
  <Type>Fare</Type>
  <Oneway>160</Oneway>
  <RevisionStatus>previous</RevisionStatus>
  <Round>320</Round>
</Price>
:

運賃が運賃改定に対応しているかを判定する

関連URL

手順

fareRevisionStatusをご利用の場合