定期券情報の作成と更新

定期券情報の作成と更新を行います。

駅や路線は、新設や廃止があるため、定期券情報の定期的な更新を推奨しております。


 Attention!

定期として利用することができる経路は鉄道のみです。

関連URL

手順

1. 定期経路文字列を作成する

平均待ち時間による探索を行います。
ダイヤによる探索では定期経路の文字列を作成することはできません。
リクエスト例では経路探索/search/course/extreme を利用していますが、 平均待ち時間による探索を行うことができるAPI(経路簡易探索平均待ち時間探索)でも可能です。

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

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=高円寺:渋谷&searchType=plain
<ResultSet apiVersion="1.27.0.0" engineVersion="201704_01a">
<Course searchType="plain" dataType="plain">
<Route timeOther="9" timeOnBoard="13" exhaustCO2="202" index="1" exhaustCO2atPassengerCar="1545" distance="92" timeWalk="0" transferCount="1">
<Point index="1">
<Station code="22671">
<Name>高円寺</Name>
:
<Line direction="Up" stopStationCount="1" teiki3Index="1" teiki6Index="1" timeOnBoard="6" exhaustCO2="127" fareIndex="1" index="1" exhaustCO2atPassengerCar="974" distance="58" teiki1Index="1">
<Name>JR中央線快速</Name>
:
<Point index="2">
<Station code="22741">
<Name>新宿</Name>
:
<Line direction="Down" stopStationCount="2" teiki3Index="1" teiki6Index="1" timeOnBoard="7" exhaustCO2="74" fareIndex="1" index="2" exhaustCO2atPassengerCar="571" distance="34" teiki1Index="1">
<Name>JR山手線内回り</Name>
:
<Point index="3">
<Station code="22715">
<Name>渋谷</Name>
:

駅の名称 ResultSet/Course/Route/Point/Station/Name と、 平均路線 ResultSet/Course/Route/Line/Name と、 平均路線の方向 ResultSet/Course/Route/Line/direction の 文字列を : でつなげて、 高円寺:JR中央線快速:Up:新宿:JR山手線内回り:Down:渋谷 という定期経路文字列を作成します。


 Attention!

定期経路文字列の駅の名称平均路線平均路線の方向 は、必ず正しい名称を指定してください。
「駅すぱあと」に存在しない駅の名称平均路線を指定してしまったり、順序が正しくないと、意図しない定期券経路が利用される可能性があります。

正) 高円寺:JR中央線快速:Up:新宿:JR山手線内回り:Down:渋谷
誤) 高円寺:JR中央線快速:Up:新宿:JR山手線内回り:Down:渋谷
誤) 高円寺:JR中央線快速:Up:新宿:JR山手線:Down:渋谷
誤) 高円寺:JR中央線快速・東京行:Up:新宿:JR山手線内回り:Down:渋谷

定期券情報の利用は定期券利用時の運賃計算をご確認ください。

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

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

経路探索/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