WebAPI Document - GUIソリューション - データフォーマット
1.出力データフォーマット
探索結果を指定したURLへ送信する場合のパラメータです。
探索結果から直接送信する場合は「単一経路」、一度探索リストへ保存して一括送信する場合は「複数経路」を参照してください。
※受け取るURLはflash.confの"RequestURL"にて指定してください。
※探索リストから送信する場合、1経路のみ保存した場合でも「複数経路」の形式で送信されます。
※探索結果が求められなかった場合、下記のパラメータは送信されません(v1.3以降)。
パラメータ名 | 値の説明
|
---|
val_route | 経路名
|
val_from | 出発地
|
val_to | 目的地
|
val_year | 出発年
|
val_month | 出発月
|
val_day | 出発日
|
val_dep_date | 出発日
|
val_arr_date | 到着日
|
val_dep_time | 出発日
|
val_dep_time | 出発時刻
|
val_arr_time | 到着時刻
|
val_time | 所要時間
|
val_board_time | 乗車時間合計
|
val_walk_time | 徒歩時間合計
|
val_walk_time | 徒歩時間合計
|
val_other_time | その他時間合計
|
val_dist | 距離
|
val_transfer | 乗換え回数
|
val_fare | 乗車券の合計金額
|
val_surcharge_fare | 特別料金合計金額
|
val_round | 往復フラグ
|
val_teiki1 | 1ヵ月の定期代
|
val_teiki3 | 3ヵ月の定期代
|
val_teiki6 | 6ヵ月の定期代
|
val_line_cnt | 路線数
|
val_line_name_[区間番号] | 路線名
|
val_line_from_[区間番号] | 路線の出発駅名
|
val_line_to_[区間番号] | 路線の到着駅名
|
val_line_dep_time_[区間番号] | 路線の出発時刻
|
val_line_arr_time_[区間番号] | 路線の到着時間
|
val_line_dist_[区間番号] | 路線の距離
|
val_line_stop_station_cnt_[区間番号] | 路線の途中停車駅数
|
val_line_traffic_[区間番号] | 路線の交通種類(train:列車/plane:飛行機/ship:船/bus:バス/walk:徒歩)※
|
val_line_type_[区間番号] | 路線の種別(0:通常、1: 乗入れ、2:折り返し)
|
val_line_direction_[区間番号] | 方向
|
val_fsect_cnt | 乗車券の料金の区間数
|
val_fsect_from_[区間番号] | この区間の料金開始路線
|
val_fsect_to_[区間番号] | この区間の料金終了路線
|
val_fsect_fare_[区間番号] | この区間の乗車券料金
|
val_fsect_not_correspond_consumption_tax_[区間番号] | 乗車券料金の消費税率引き上げに伴う改定(1:対応していない)
|
val_csect_cnt | 特別料金の区間数
|
val_csect_from_[区間番号] | この区間の特急列車開始路線
|
val_csect_to_[区間番号] | この区間の特急列車終了路線
|
val_csect_surcharge_[区間番号]_cnt | この区間の特急列車情報数(必ず1が入ります)
|
val_csect_surcharge_[区間番号]_name_1 | この区間の特急列車座席名称
|
val_csect_surcharge_[区間番号]_fare_1 | この区間の特急列車の料金
|
val_csect_not_correspond_consumption_tax_[区間番号] | 特急列車料金の消費税率引き上げに伴う改定(1:対応していない)
|
val_besttime | 時間順最適経路のフラグ(1が入ります)
|
val_bestprice | 金額順最適経路のフラグ(1が入ります)
|
val_besttransfercount | 乗り換え回数順最適経路のフラグ(1が入ります)
|
val_bestco2 | CO2排出量順最適経路のフラグ(1が入ります)
|
val_bestteiki1 | 定期券金額(1ヶ月)最適経路のフラグ(1が入ります)
|
val_bestteiki3 | 定期券金額(3ヶ月)最適経路のフラグ(1が入ります)
|
val_bestteiki6 | 定期券金額(6ヶ月)最適経路のフラグ(1が入ります)
|
val_withteiki | 定期券利用フラグ(1が入ります)
|
val_routeno | 選択した経路番号
|
val_resultcount | 探索時の結果数
|
val_searchword | 探索時の文字列
|
val_xml | XMLデータ ※仕様はこちら→?http://api.ekispert.jp/doc/api/search/course/extreme.html
|
val_errcode | エラーコード(正常時:0)
|
※駅すぱあとイントラネットでのパラメータ
1:列車、2:飛行機、3:連絡バス、4:船、5:徒歩、6:路線バス、7:高速バス、15:ランドマーク
パラメータ名 | 値の説明
|
---|
val_route_cnt | 探索結果の数
|
val_route_[経路番号] | 経路名
|
val_from_[経路番号] | 出発地
|
val_to_[経路番号] | 目的地
|
val_year_[経路番号] | 出発年
|
val_month_[経路番号] | 出発月
|
val_day_[経路番号] | 出発日
|
val_dep_date_[経路番号] | 出発日
|
val_arr_date_[経路番号] | 到着日
|
val_dep_time_[経路番号] | 出発時刻
|
val_arr_time_[経路番号] | 到着時刻
|
val_time_[経路番号] | 所要時間
|
val_board_time_[経路番号] | 乗車時間合計
|
val_walk_time_[経路番号] | 徒歩時間合計
|
val_other_time_[経路番号] | その他時間合計
|
val_dist_[経路番号] | 距離
|
val_transfer_[経路番号] | 乗換え回数
|
val_fare_[経路番号] | 乗車券の合計金額
|
val_surcharge_fare_[経路番号] | 特別料金合計金額
|
val_round_[経路番号] | 往復フラグ
|
val_teiki1_[経路番号] | 1ヵ月の定期代
|
val_teiki3_[経路番号] | 3ヵ月の定期代
|
val_teiki6_[経路番号] | 6ヵ月の定期代
|
val_r[経路番号]_line_cnt | 路線数
|
val_r[経路番号]_line_name_[区間番号] | 路線名
|
val_r[経路番号]_line_from_[区間番号] | 路線の出発駅名
|
val_r[経路番号]_line_to_[区間番号] | 路線の到着駅名
|
val_r[経路番号]_line_dep_time_[区間番号] | 路線の出発時刻
|
val_r[経路番号]_line_arr_time_[区間番号] | 路線の到着時間
|
val_r[経路番号]_line_dist_[区間番号] | 路線の距離
|
val_r[経路番号]_line_stop_station_cnt_[区間番号] | 路線の途中停車駅数
|
val_r[経路番号]_line_traffic_[区間番号] | 路線の交通種類(train:列車/plane:飛行機/ship:船/bus:バス/walk:徒歩)※
|
val_r[経路番号]_line_type_[区間番号] | 路線の種別(0:通常、1: 乗入れ、2:折り返し)
|
val_r[経路番号]_line_direction_[区間番号] | 方向
|
val_r[経路番号]_fsect_cnt | 乗車券の料金の区間数
|
val_r[経路番号]_fsect_from_[区間番号] | この区間の料金開始路線
|
val_r[経路番号]_fsect_to_[区間番号] | この区間の料金終了路線
|
val_r[経路番号]_fsect_fare_[区間番号] | この区間の乗車券料金
|
val_r[経路番号]_fsect_not_correspond_consumption_tax_[区間番号] | 乗車券料金の消費税率引き上げに伴う改定(1:対応していない)
|
val_r[経路番号]_csect_cnt | 特別料金の区間数
|
val_r[経路番号]_csect_from_[区間番号] | この区間の特急列車開始路線
|
val_r[経路番号]_csect_to_[区間番号] | この区間の特急列車終了路線
|
val_r[経路番号]_csect_surcharge_[区間番号]_cnt | この区間の特急列車情報数(必ず1が入ります)
|
val_r[経路番号]_csect_surcharge_[区間番号]_name_1 | この区間の特急列車座席名称
|
val_r[経路番号]_csect_surcharge_[区間番号]_fare_1 | この区間の特急列車の料金
|
val_r[経路番号]_csect_not_correspond_consumption_tax_[区間番号] | 特急列車料金の消費税率引き上げに伴う改定(1:対応していない)
|
val_besttime_[経路番号] | 時間順最適経路のフラグ(1が入ります)
|
val_bestprice_[経路番号] | 金額順最適経路のフラグ(1が入ります)
|
val_besttransfercount_[経路番号] | 乗り換え回数順最適経路のフラグ(1が入ります)
|
val_bestco2_[経路番号] | CO2排出量順最適経路のフラグ(1が入ります)
|
val_bestteiki1_[経路番号] | 定期券金額(1ヶ月)最適経路のフラグ(1が入ります)
|
val_bestteiki3_[経路番号] | 定期券金額(3ヶ月)最適経路のフラグ(1が入ります)
|
val_bestteiki6_[経路番号] | 定期券金額(6ヶ月)最適経路のフラグ(1が入ります)
|
val_withteiki_[経路番号] | 定期券利用フラグ(1が入ります)
|
val_routeno_[経路番号] | 選択した経路番号
|
val_resultcount_[経路番号] | 探索時の結果数
|
val_searchword_[経路番号] | 探索時の文字列
|
val_xml_[経路番号] | XMLデータ ※仕様はこちら→?http://api.ekispert.jp/doc/api/search/course/extreme.html
|
val_errcode | エラーコード(正常時:0)
|
※駅すぱあとイントラネットでのパラメータ
1:列車、2:飛行機、3:連絡バス、4:船、5:徒歩、6:路線バス、7:高速バス、15:ランドマーク
[区間番号]:路線や料金の区間ごとに1・2・3・・・とカウントアップしていきます。
[経路番号]:探索結果数に応じて1・2・3・・・とカウントアップしていきます。
ご契約いただく内容によっては、パラメータが設定されていないことがあります。
2.JavaScript連携フォーマット
FlashとJavaScriptの連携ファンクション名、および、引数です。
なお、すべてJavaScriptからの呼び出しがトリガーとなります。
また、探索結果や探索条件等のコールバック関数に関しては、各コンポーネントの設定をご確認ください。
→コールバック用の関数設定はこちらflash.conf
ファンクション名 | 引数 | 説明
|
---|
setDate | yyyymmdd | 探索日付をセットします。
|
setTime | hhss | 探索時間をセットします。
|
setKind | departure/arrival/plain | 探索属性を変更します。
|
setStation1 | 駅名 | 出発地をセットします。
|
setStation2 | 駅名 | 目的地/経由駅をセットします。
|
setStation3 | 駅名 | 目的地/経由駅をセットします。
|
setStation4 | 駅名 | 目的地/経由駅をセットします。
|
setStation5 | 駅名 | 目的地/経由駅をセットします。
|
setStation6 | 駅名 | 目的地をセットします。
|
setStationList | 駅名 | 駅名を一括でセットします。※
|
※駅名の区切りは","もしくは":"で行ってください。
ファンクション名 | 引数 | 説明
|
---|
setStation | 駅名 | 駅名をセットします。
|
ファンクション名 | 引数 | 説明
|
---|
search | 探索文字列※ | 外部から探索を実行する際に探索条件を引数として呼び出します(全体表示)。
|
searchWindow | 探索文字列※ | 外部から探索を実行する際に探索条件を引数として呼び出します(ウィンドウ表示)。
|
setResult | 探索結果XML | 取得済みの探索結果を表示します(全体表示)。
|
setResultWindow | 探索結果XML | 取得済みの探索結果を表示します(ウィンドウ表示)。
|
setSerializeData | シリアライズデータ | シリアライズデータを探索結果に復元します(全体表示)。
|
setSerializeDataWindow | シリアライズデータ | シリアライズデータを探索結果に復元します(ウィンドウ表示)。
|
ファンクション名 | 引数 | 説明
|
---|
setConditionType | departure/arrival/dia/plain/teiki/average | departure/arrival/dia:時刻表探索の探索条件にします。 plain/teiki/average:平均探索の探索条件にします。
|
ファンクション名 | 引数 | 説明
|
---|
setSerializeData | シリアライズデータ | 外部から払い戻し経路を指定する際に探索条件を引数として呼び出します。
|
search | 探索文字列※ | 外部から払い戻し経路を探索する際に探索条件を引数として呼び出します。
|
ファンクション名 | 引数 | 説明
|
---|
setSerializeData | シリアライズデータ | 外部から経路を指定する際に探索条件を引数として呼び出します。
|
search | 探索文字列※ | 外部から経路を探索する際に探索条件を引数として呼び出します。
|
ファンクション名 | 引数 | 説明
|
---|
setMapStation | 駅名 | 指定した駅座標へ移動します。
|
changeMap | 路線図名 | 指定した路線図を表示します。
|
setMapNavi | true/false | 概観図の表示・非表示を切り替えます。
|
addMapStation | 駅コード | 引数で指定した駅アイコンにマークを設定します。
|
viewMapStation | 整数 | 駅アイコンを光らせます(1〜3を指定)。
|
removeMapStation | なし | 駅アイコンを消灯します。
|
ファンクション名 | 引数 | 説明
|
---|
searchStation | 駅名 | 駅名を検索します。
|
ファンクション名 | 引数 | 説明
|
---|
searchStation | 駅名 | 駅名で範囲探索を行います。
|
ファンクション名 | 引数 | 説明
|
---|
getStation1 | なし | 1つ目の駅名入力内容が取得できます。
|
getStation2 | なし | 2つ目の駅名入力内容が取得できます。
|
getStation3 | なし | 3つ目の駅名入力内容が取得できます。
|
getStation4 | なし | 4つ目の駅名入力内容が取得できます。
|
getStation5 | なし | 5つ目の駅名入力内容が取得できます。
|
getStation6 | なし | 6つ目の駅名入力内容が取得できます。
|
getStation | 1〜6 | 指定した箇所の駅名入力内容が取得できます。
|
ファンクション名 | 引数 | 説明
|
---|
getStation | なし | 駅名入力内容が取得できます。
|
ファンクション名 | 引数 | 説明
|
---|
getResult | なし | 探索結果を取得します(表示している経路のみ)。
|
getResultAll | なし | 探索結果を取得します(探索結果全体)。
|
※探索結果取得はアクティブとなっている結果のみ取得可能です。
※探索を行っていない場合は、空文字となります。
※探索結果取得を閉じるなどですべてのウィンドウが非アクティブとなっている場合は空文字となります。
ファンクション名 | 引数 | 説明
|
---|
getXml | 探索文字列※ | 払い戻し金額のXMLデータを取得します。
|
getRepayPrice | 探索結果XML | 払い戻し金額のを取得します。
|
getRepayPriceList | 探索結果XML | 払い戻し金額のリストデータを取得します。※
|
※"開始駅,終了駅,購入金額,使用済み金額,手数料,払い戻し金額"を:(コロン)で枚数分繰り返します。
ファンクション名 | 引数 | 説明
|
---|
getXml | なし | 分割計算のXMLデータを取得します。
|
getDividedPrice | なし | 分割計算の合計金額を取得します。
|
getDividedPriceList | なし | 分割金額のリストデータを取得します。※
|
※"開始駅,終了駅,購入金額"を:(コロン)で枚数分繰り返します。
ファンクション名 | 引数 | 説明
|
---|
getStation | なし | 検索結果の一つ目の駅名を取得します。
|
getStationList | なし | 検索結果すべての駅名を取得します。
|
ファンクション名 | 引数 | 説明
|
---|
getCheckStation | なし | チェックを入れた駅リストを取得します。
|
値のセパレータはアンパサンド"&"、または、セミコロン";"で行ってください。
それ以外はWebAPIの仕様と同じです。
※API仕様はこちら→http://api.ekispert.jp/doc/api/search/course/extreme.html
例:viaList=高円寺:東京&date=20100922&time=1019&searchType=lastTrain&answerCount=3