public static final class EkispertWebKey.SearchCourseExtreme extends Object
指定された駅もしくは地点間の、公共交通機関を利用した経路を探索します。 平均待ち時間による探索や、ダイヤによる探索(発時刻探索など)が行えます。■ 平均待ち時間による探索
列車の平均待ち時間を考慮して経路の探索を行います。 平均待ち時間は、空路だと1日に1便しかない場合でも約20分で設定されており、実際の待ち時間と一致しません。 また、曜日によって運航する空路に関しては、出発日を無視し経路を探索するようにしています。■ ダイヤによる探索 (発時刻探索、着時刻探索、終電探索、始発探索)
時刻表のダイヤから、 ・ 発時刻探索は、早く到着し遅く出発する経路 ・ 着時刻探索は、遅く出発し早く到着する経路 ・ 終電探索は、出発/到着日の最終ダイヤ(翌日午前3時まで)で到着する経路 ・ 始発探索は、出発/到着日に出発し最も早く到着する経路 をそれぞれ探索します。 結果として経路が存在しない場合(空港への探索で飛行機の利用を抑止している、固定した路線で経路が作成できない、など)、エラーではなく空の結果が返ります。 ※ リクエストやレスポンスに座標が含まれる場合、座標の測地系をgcsパラメータで指定することができます。 ※ リクエストパラメータに日本語が含まれる場合には、UTF8でURLエンコードしてください。 ※ 「複数指定可」となっているパラメータに値を複数指定する場合は、コロン(:)区切りで記述してください。
http://api.ekispert.jp/doc/api/search/course/extreme.html
修飾子とタイプ | フィールドと説明 |
---|---|
static String |
ADDASSIGNSTATUS
定期券などの利用時に、レスポンスに割り当てステータスを付加
(assignRoute, assignDetailRoute, assignTeikiSerializeDataのいずれか指定時のみ有効, 省略可, 省略時はfalse。
|
static String |
ANSWERCOUNT
最大回答数(最大20, 省略時は5となります).
|
static String |
ASSIGNDETAILROUTE
定期割り当て用詳細経路文字列(駅名:路線名:方向:駅名...の羅列)(assignTeikiSerializeData, assignRouteと排他, 省略可).
|
static String |
ASSIGNNIKUKANTEIKIINDEX
二区間定期インデックス.
|
static String |
ASSIGNROUTE
定期割り当て用経路文字列(駅名:路線名:駅名...の羅列)(assignTeikiSerializeData, assignDetailRouteと排他, 省略可).
|
static String |
ASSIGNTEIKISERIALIZEDATA
定期経路シリアライズデータ(assignRoute, assignDetailRouteと排他, 省略可).
|
static String |
BRINGASSIGNMENTERROR
割り当てエラーの場合のエラー判定(割り当てエラーを発生させる:true, 割り当てエラーを発生させない:false, 省略時はfalse).
|
static String |
CHECKENGINEVERSION
定期経路シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェック実施有無(省略可, 省略時はtrue).
|
static String |
CONDITIONDETAIL
詳細探索条件データ(探索条件生成から取得可能)(省略時はデフォルトの条件となります).
|
static String |
CORPORATIONBIND
固定会社名(指定した会社のみ利用します)(複数指定可:最大10件, 省略時は制限のない通常の探索となります).
|
static String |
COUPON
割り当て回数券詳細名称(省略可).
|
static String |
DATE
探索日付(YYYYMMDD)(省略時は現在日付となります).
|
static String |
FIXEDRAILDIRECTIONLIST
固定路線の方向リスト(searchType=plain,fixedRailList指定時のみ有効, 省略時は方向を自動的に判断します).
|
static String |
FIXEDRAILLIST
固定路線の名称リスト(searchType=plain指定時のみ有効, 省略時は路線を固定しません).
|
static String |
INTERRUPTCORPORATIONLIST
不通会社リスト(指定した会社を利用しない経路を求めます)(searchType:plainの場合のみ有効, 省略時は制限のない通常の探索となります).
|
static String |
INTERRUPTRAILLIST
不通路線リスト(指定した路線を利用しない経路を求めます)(searchType:plainの場合のみ有効, 省略時は制限のない通常の探索となります).
|
static String |
OFFPEAKTEIKIMODE
オフピーク定期券利用時の計算モード(オフピーク定期として控除するかしないかを設定, 省略可).
|
static String |
RESULTDETAIL
詳細情報付加(路線に会社を付加:addCorporation, 省略時は通常の結果となります).
|
static String |
SEARCHCOUNT
最大探索数(最大20, 省略時は5となります).
|
static String |
SEARCHTYPE
探索種別(発時刻探索:departure, 着時刻探索:arrival, 終電探索:lastTrain, 始発探索:firstTrain, 平均待ち時間探索:plain, 省略された場合は、発時刻探索となります).
|
static String |
SORT
ソート種別(駅すぱあと探索順:ekispert, 料金順:price, 時間順:time, 定期券の料金順:teiki, 乗換回数順:transfer, CO2排出量順:co2, 1ヶ月定期券の料金順:teiki1,
3ヶ月定期券の料金順:teiki3, 6ヶ月定期券の料金順:teiki6, 省略された場合は、駅すぱあと探索順となります).
|
static String |
TIME
探索時刻(HHMM)(省略時は現在時刻となります).
|
static String |
VIALIST
駅コードや座標などのリスト(複数指定可:最大20件程度が目安).
|
コンストラクタと説明 |
---|
SearchCourseExtreme() |
public static final String VIALIST
■ viaListについて
viaListは駅コード(または駅名称)、座標情報、もしくは地点データの列挙で指定します。 指定順序には意味があり、 ・ 先頭は出発駅(地) ・ 末端は目的駅(地) ・ その間にあるものは経由駅(地) として解釈されます。 経由駅(地)には駅か座標情報を指定できます。 経由駅(地)に座標情報を指定した場合は、座標から最も近い駅を指定したものとみなします。 また、経由駅(地)としてバス停は指定できません。 例1:駅のみの場合(東京→高円寺→大阪) 22828:22671:25853 例2:座標情報を含む場合 35.40.41.1,139.46.12.9,tokyo,20:25853
public static final String FIXEDRAILLIST
■ fixedRailListについて(路線の固定)
駅間の路線の固定は、fixedRailListに路線名称を指定して行います (この指定が有効なのはsearchType=plainの場合のみです)。 指定順序には意味があり、指定された順にviaListの駅と駅をつなぐ要素となります。 このため指定時の最大数は「viaListの要素数-1」です。 また、座標指定を含む区間には無効です。 例1:横浜->新宿->池袋の新宿池袋間を「JR埼京線」に固定する場合(一つ目の指定は空) viaList=23368:22741:22513&fixedRailList=:JR埼京線
public static final String FIXEDRAILDIRECTIONLIST
public static final String SEARCHTYPE
public static final String SORT
public static final String CONDITIONDETAIL
public static final String CORPORATIONBIND
public static final String INTERRUPTCORPORATIONLIST
public static final String INTERRUPTRAILLIST
public static final String RESULTDETAIL
public static final String ASSIGNROUTE
■ assignRoute、assignDetailRouteの指定について(定期割り当て)
assignRouteおよびassignDetailRouteの路線名は、 平均待ち時間による探索で得られた結果に含まれるLineの名称を指定します。 同じ名称は、路線情報にfromとtoを指定した場合にも得られます。 上記手段以外(出発時刻探索など)により取得した路線名を指定すると、定期の割り当てが正常に行われない可能性があります。
public static final String ASSIGNDETAILROUTE
■ assignRoute、assignDetailRouteの指定について(定期割り当て)
assignRouteおよびassignDetailRouteの路線名は、 平均待ち時間による探索で得られた結果に含まれるLineの名称を指定します。 同じ名称は、路線情報にfromとtoを指定した場合にも得られます。 上記手段以外(出発時刻探索など)により取得した路線名を指定すると、定期の割り当てが正常に行われない可能性があります。
public static final String ASSIGNNIKUKANTEIKIINDEX
定期割り当て用経路が二区間定期の場合、その状態を表すPassStatusのindexを指定します。 複数指定可(複数指定時に同区間のインデックスが指定された場合はどれか一つを適用します), 省略時は定期割り当て経路は通常の定期となります).
public static final String BRINGASSIGNMENTERROR
■ bringAssignmentErrorの指定について
通常の経路探索おける定期と回数券の割り当てでは、 割り当てられない場合でもエラーとならず経路探索結果を返します。 bringAssignmentErrorでtrueを指定すると、 割り当てが行えない場合などにエラーを返すようになります。
public static final String ASSIGNTEIKISERIALIZEDATA
定期区間控除を行いたい経路に対して、事前に取得した定期経路シリアライズデータを指定します。
public static final String CHECKENGINEVERSION
チェックが有効な場合、エンジンバージョンが異なる場合はエラーを返します。 true: チェックする、false: チェックしない
public static final String ADDASSIGNSTATUS
true: 割り当てステータスを付加する、false: 割り当てステータスを付加しない
public static final String OFFPEAKTEIKIMODE
offpeakTime:オフピーク時間帯の利用とみなして運賃計算するため、定期区間が含まれる経路の場合は定期区間控除されます。 peakTime:ピーク時間帯の利用とみなして運賃計算するため、定期区間が含まれる経路であっても控除されません。
Copyright © 2024 Sumitomo Life Information Systems Co., Ltd. All Rights Reserved.