経路探索時に詳細な条件を設定する
「新幹線利用」や「有料特急利用」等、経路探索時に詳細な条件を設定します。
※API利用時のイメージ図 (駅すぱあと API HTML5 インターフェースサンプル)
関連URL
手順
1. 経路探索に用いる条件を生成する
GET /v1/xml/toolbox/course/condition?key=アクセスキーを入力してください&plane=normal&shinkansen=normal&shinkansenNozomi=normal&sleeperTrain=possible&limitedExpress=normal
<ResultSet apiVersion="1.27.0.0" engineVersion="202010_02a">
<Condition>T3223233232319:F3321122120000:A23121141:</Condition>
</ResultSet>
2. 経路探索を行う
1で生成した詳細探索条件を用いて経路探索 /search/course/extreme を行います。
※リクエスト例では日本語で記述しておりますが、リクエストパラメータに日本語が含まれる場合には、日本語の部分をUTF8でURLエンコード(パーセントエンコード)してください。
GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=高円寺:阿佐ヶ谷&conditionDetail=T3223233232319:F3321122120000:A23121141:
<ResultSet apiVersion="1.27.0.0" engineVersion="202010_02a">
<Course searchType="departure" dataType="onTimetable">
<Route index="1" ... >
<Point index="1">
<Station code="22671">
<Name>高円寺</Name>
<Type>train</Type>
<Yomi>こうえんじ</Yomi>
</Station>
:
</Point>
:
