はじめに
Tips一覧
定期券
探索(運賃)
探索(探索結果)
探索(探索条件)
探索(地点)
探索(路線)
路線図

定期情報の更新

定期情報の更新を行います。
駅や路線は、新設や廃止があるため、定期情報の定期的な更新を推奨しております。
また、定期情報の更新判定ステータスコードを確認することで、更新が必要になったことを知ることができます。

関連URL

更新判定ステータスによる判定

まず、経路探索で定期区間の控除を行います。

割り当て対象種別ResultSet/Course/AssignStatus/kindteikiの定期割り当てステータスを表す要素ResultSet/Course/AssignStatusのうち、定期情報の更新判定ステータスコードを表すrequireUpdateにより、割り当てた経路情報に更新の必要があるかを確認できます。
ここでは浅草:東武伊勢崎線区間準急:Down:業平橋という定期経路文字列を例としています。

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

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&addAssignStatus=true&viaList=浅草:とうきょうスカイツリー&assignDetailRoute=浅草:東武伊勢崎線区間準急:Down:業平橋&time=1000
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201810_01a">
   <Course searchType="departure" dataType="onTimetable">
        :
      <!-- requireUpdate属性には、定期経路文字列に旧名称の駅名が指定されていることを表す1が返っています。これは定期経路文字列のうち、業平橋駅がとうきょうスカイツリー駅と改称されたためです。 -->
      <AssignStatus requireUpdate="1" kind="teiki" code="0" />
      <Route ...>
          :
         <Point index="2">
            <Station code="22859">
               <Name>とうきょうスカイツリー</Name>
                :
            </Station>
              :
         </Point>
      </Route>
   </Course>
</ResultSet>

定期情報の更新判定ステータスコードには、定期情報の更新が必須であることを示すものと、早めの更新が推奨されることを示すものがあります。
それぞれのステータスコードが表す意味については定期情報の更新判定ステータスコードをご覧ください。

定期情報の更新

定期経路シリアライズデータ」の場合

定期経路シリアライズデータを再登録する

定期経路シリアライズデータが再現できなくなる場合があります。

定期経路シリアライズデータを取得する際に保存した、定期経路の表示用文字列ResultSet/Course/Teiki/DetailRouteの発着駅を利用して、再度経路探索を行います。
定期情報の取得については定期情報の取得をご覧ください。

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

定期経路文字列」の場合

定期経路文字列を再取得する

定期経路文字列が再現できなくなる場合があります。
再現ができなくなる場合には、定期経路文字列を更新する必要があります。

路線・方向を固定して再取得する場合

経路探索/search/course/extremefixedRailListパラメータとfixedRailDirectionListパラメータを利用することで、路線と方向を固定して平均探索を行うことができます。

■ 定期経路文字列例

高円寺:JR中央線快速:Up:新宿:JR山手線内回り:Down:渋谷

定期経路文字列を以下のように分解して再探索します。

  • viaList=高円寺:新宿:渋谷
  • fixedRailList=JR中央線快速:JR山手線内回り
  • fixedRailDirectionList=Up:Down

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

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=高円寺:新宿:渋谷&searchType=plain&fixedRailList=JR中央線快速:JR山手線内回り&fixedRailDirectionList=Up:Down