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

「駅すぱあと API」では公共交通事業者の運賃改定に対応しています。ただし、データの入手時期などの影響により、改定日までに対応が間に合わない場合があります。

運賃改定への対応状況は、経路探索結果の金額（ResultSet / Course / Price）ごとに確認できます。 ResultSet / Course / Price / RevisionStatus要素を確認することで、その金額が運賃改定に対応しているかを判定可能です。

RevisionStatusの値は、以下のいずれかになります。

値	説明
previous	最新の運賃改定に未対応の金額
forecast	「駅すぱあと」が予測した運賃改定後の見込の金額
latest	最新の運賃改定に対応済みの金額

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

Attention!

各金額の運賃改定への対応状況（previous、forecast、latest）は、弊社のデータ更新により変化します。そのため、アプリケーション上で金額を表示する際は、金額の状態「改定に未対応」「見込の金額」「最新の改定に対応済み」がユーザーに分かりやすく伝わるよう実装することを推奨します。

※ Windows版でのイメージ図

見込の金額とは

「見込の金額」は、運賃改定時に必要な情報が不足している場合に、一部の区間について、弊社が独自に予測した金額を表示する機能です。この金額は確定情報が揃うまでの暫定的な予測値であり、後に確定情報と異なる場合がありますので、ご了承ください。また、予測に必要な情報が不足している場合や、信頼性が確保できない場合は、「見込の金額」は表示されません。詳しくは見込の金額をご覧ください。

手順

経路探索を行います。

※リクエスト例では日本語で記述しておりますが、リクエストパラメータに日本語が含まれる場合には、日本語の部分を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をご利用の場合