リクエストパラメータを元に、経路探索に利用する条件を生成します。 detailの指定がない場合は、デフォルトの条件を元に探索条件を生成します。 detailを指定した場合は、detailの値に対して指定パラメータの値を置き換えます。つまり、前回生成した詳細条件探索データの一部を変更したものを取得できます。

GET /v1/{format}/toolbox/course/condition

parameters

※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。

Name	Type	Required	Description
format	string	◯	レスポンスのデータ形式の指定。必須指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。
key	string	◯	アクセスキー。必須
detail	string	---	詳細探索条件データ。省略可 Default: T32212332323191:F33211221200001:A23121141:
plane	string	---	飛行機。省略可。指定できる値: - light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。 - normal:普通に利用 - bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。 - never:利用しない Default: normal (detailパラメータ指定時はdetailの値）
shinkansen	string	---	新幹線。省略可指定できる値: - normal:利用する - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
shinkansenNozomi	string	---	特急料金が加算される一部の新幹線。省略可。対象となる新幹線 (区間): -「ＪＲ新幹線のぞみ」 (東京 - 博多間) -「ＪＲ新幹線みずほ」 (新大阪 - 博多間) -「ＪＲ新幹線はやぶさ」 (東京 - 盛岡間) -「ＪＲ新幹線こまち」 (東京 - 盛岡間) 指定できる値: - normal:利用する - never:利用しない ※上記の新幹線の全てが対象となります。 Default: normal (detailパラメータ指定時はdetailの値)
sleeperTrain	string	---	寝台列車。省略可。指定できる値: - possible:極力利用する ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。 - normal:普通に利用 - never:利用しない Default: never (detailパラメータ指定時はdetailの値)
limitedExpress	string	---	有料特急。省略可指定できる値: - normal:利用する - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
highwayBus	string	---	高速バス。省略可。指定できる値: - light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。 - normal:普通に利用 - bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。 - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
connectionBus	string	---	連絡バス。省略可。指定できる値: - light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。 - normal:普通に利用 - bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。 - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
localBus	string	---	路線バス。省略可指定できる値: - normal:利用する - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
communityBus	string	---	路線バスに対するコミュニティバスの扱いを指定します。localBusがneverの場合無効。省略可。指定できる値: - contain:除外しない - except:除外する Default: contain
midnightBus	string	---	深夜急行バス。探索種別がplainの場合無効。省略可指定できる値: - normal:利用する - never:利用しない Default: never (detailパラメータ指定時はdetailの値)
ship	string	---	船。省略可。指定できる値: - light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。 - normal:普通に利用 - bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。 - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
liner	string	---	ライナー（乗車整理券、ライナー券、普通車指定席券が必要な列車）。探索種別がplainの場合無効。省略可指定できる値: - normal:利用する - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
walk	string	---	駅間徒歩。探索種別がplainの場合のみ有効。省略可指定できる値: - normal:気にならない - little:少し気になる - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
useJR	string	---	ＪＲ路線。探索種別がplainの場合のみ有効。省略可指定できる値: - light:気軽に利用 - normal:普通に利用 - bit:極力利用しない Default: normal (detailパラメータ指定時はdetailの値)
transfer	string	---	乗り換え。探索種別がplainの場合のみ有効。省略可指定できる値: - normal:気にならない - little:少し気になる - never:利用しない Default: normal (detailパラメータ指定時はdetailの値)
waitAverageTime	string	---	出発駅での平均的な乗車待ち時間の設定。探索種別がplainの場合のみ有効。省略可指定できる値: - true: 出発駅での平均的な乗車待ち時間を含める - false: 出発駅での平均的な乗車待ち時間を含めない Default: true (detailパラメータ指定時はdetailの値)
expressStartingStation	string	---	特急始発駅。探索種別がplainの場合にのみ有効。省略可指定できる値: - possible:なるべく利用 - normal:普通に利用 Default: normal (detailパラメータ指定時はdetailの値)
localBusOnly	string	---	路線バスのみ探索。探索種別がplainの場合にのみ有効。省略可指定できる値: - true:する - false:しない Default: false (detailパラメータ指定時はdetailの値)
transferTime	string	---	乗り換え時間。探索種別がplainの場合は無効。省略可指定できる値: - normal:「駅すぱあと」の規定値 - moreMargin:規定値より少し余裕をみる - mostMargin:規定値より余裕をみる - lessMargin:規定値より短い時間にする Default: normal (detailパラメータ指定時はdetailの値)
fuzzyLine	string	---	固定平均路線の名称リストにおける平均路線名あいまい指定。探索種別がplainの場合にのみ、`fixedRailList`パラメータに対して有効。 trueの場合は平均路線名に対する部分一致の指定となりますが、意図しない路線が選択される可能性があります。省略可指定できる値: - true:あいまいに行う（部分一致） - false:厳格に行う（完全一致） Default: false (detailパラメータ指定時はdetailの値)
entryPathBehavior	string	---	経路を加工する際に、経由駅を継承する。省略可指定できる値: - true:する - false:しない Default: false (detailパラメータ指定時はdetailの値) 詳しくはこちらを参照。
surchargeKind	string	---	料金種別希望初期値。省略可。指定できる値: - free:自由席 - reserved:指定席 - green:グリーン Default: free (detailパラメータ指定時はdetailの値) ※新幹線や特急列車など、運賃の他に料金が必要な列車に対し適応されます。ただし運賃のみで利用可能な座席がある列車では適応されません (例: 湘南新宿ライン、快速マリンライナーなど)。
teikiKind	string	---	定期券種別初期値。省略可指定できる値: - bussiness:通勤 - university:通学 (大学) - highSchool:通学 (高校) - juniorHighSchool:通学 (中学) Default: bussiness (detailパラメータ指定時はdetailの値)
JRSeasonalRate	string	---	ＪＲ季節料金。省略可指定できる値: - true:繁忙期・閑散期の季節料金を考慮する - false:無視する Default: true (detailパラメータ指定時はdetailの値)
JRReservation	string	---	EX予約/スマートEXサービス。studentDiscountと同時指定は不可。経路探索で回数券が指定された場合は、回数券が優先されます。省略可指定できる値: - none: 計算しない＜EX予約＞ - exYoyaku: ＥＸ予約 - exETokkyu: ＥＸ予約(ｅ特急券) - exHayatoku: ＥＸ予約(ＥＸ早特) - exHayatoku1: ＥＸ予約(ＥＸ早特１) - exHayatoku21: ＥＸ予約(ＥＸ早特２１) - exHayatoku28: ＥＸ予約(ＥＸ早特２８) - exGreenHayatoku: ＥＸ予約(ＥＸグリーン早特) ＜スマートEX＞ - smartEx: スマートＥＸ - smartExHayatoku: スマートＥＸ(ＥＸ早特) - smartExHayatoku1: スマートＥＸ(ＥＸ早特１) - smartExHayatoku21: スマートＥＸ(ＥＸ早特２１) - smartExHayatoku28: スマートＥＸ(ＥＸ早特２８) - smartExGreenHayatoku: スマートＥＸ(ＥＸグリーン早特) Default: none
shinkansenETicket	string	---	新幹線eチケットサービス。studentDiscountと同時指定は不可。経路探索で回数券が指定された場合は、回数券が優先されます。省略可指定できる値: - none: 計算しない - eTicket: 新幹線ｅチケット Default: none
studentDiscount	string	---	学割乗車券。JRReservation、shinkansenETicketと同時指定は不可。省略可指定できる値: - true:計算する - false:計算しない Default: false (detailパラメータ指定時はdetailの値)
ticketSystemType	string	---	乗車券計算のシステム。省略可指定できる値: - normal:普通乗車券のみ計算する - ic:ICカード乗車券も計算する Default: normal (detailパラメータ指定時はdetailの値)
preferredTicketOrder	string	---	優先する乗車券の順序。乗車券計算のシステムに"ic"を設定した場合のみ有効。省略可指定できる値: - none:指定なし - normal:普通乗車券を優先する - ic:ICカード乗車券を優先する - cheap:安い乗車券を優先する Default: none (detailパラメータ指定時はdetailの値)
nikukanteiki	string	---	「定期券の種類: 二区間定期券」の利用。省略可指定できる値: - true:利用する - false:利用しない Default: false (detailパラメータ指定時はdetailの値)
offpeakTeiki	string	---	オフピーク定期券として計算する。省略可。指定できる値: - true:計算する - false:計算しない Default: false (detailパラメータ指定時はdetailの値) ※offpeakTeiki=trueを指定した場合、経路探索の結果に定期区間が「オフピーク定期区間かの状態判定」が追加され、オフピーク定期区間の場合は定期代がオフピーク定期券の金額となります。詳しくはオフピーク定期券の定期代を調べるをご確認ください。

entryPathBehavior

経路を加工する際に、経由駅指定を継承させたい場合に利用します。経路の再現／定期券・指定列車利用を利用して「次のダイヤを適応する」などの経路の加工を行った場合、経路の最適化により経由駅を含む冗長な区間が削除される可能性があります。 entryPathBehavior=trueを指定した詳細探索条件を探索時に利用することで、経路を加工する際に経由駅指定が継承される探索結果を得られます。

response

Name	Description
ResultSet	レスポンスの最下部を表す要素
ResultSet / apiVersion	WebAPIバージョン
ResultSet / engineVersion	エンジンバージョン
ResultSet / Condition	詳細探索条件を表す要素

example

GET /v1/xml/toolbox/course/condition?key=アクセスキーを入力してください&plane=normal&walk=little

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="202303_01a">
  <Condition>T32212332322191:F33211221200001:A23121141:</Condition>
</ResultSet>

GET /v1/json/toolbox/course/condition?key=アクセスキーを入力してください&plane=normal&walk=little

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "202303_01a",
    "Condition": "T32212332322191:F33211221200001:A23121141:"
  }
}