駅すぱあと for web URL生成

駅すぱあと for web で探索結果を表示するためのURLを生成します。リクエストパラメータのredirectにtrueを指定すると、レスポンスを生成したURLへのリダイレクトとして返します。

GET /v1/{format}/search/course/light

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー 。必須
from string 出発駅(地)。駅コード駅の名称を指定可能です。
to string 到着駅(地)。駅コード駅の名称を指定可能です。
via string 経由駅(地)。駅コード駅の名称を指定可能です。省略可。省略時は指定なしとなります。
date int 探索日付。省略可。
Format: YYYYMMDD
Default: 現在日付
time int 探索時刻。省略可。
Format: HHMM
Default: 現在時刻
searchType string 探索種別。省略可。
指定できる値:
- departure: 発時刻探索
- arrival: 着時刻探索
- lastTrain: 終電探索
- firstTrain: 始発探索
Default: departure
plane string 飛行機。省略可。
指定できる値:
- true: 利用する
- false 利用しない
Default: true
shinkansen string 新幹線(のぞみ含む)。省略可。
指定できる値:
- true: 利用する
- false 利用しない
Default: true
limitedExpress string 特急。省略可。
指定できる値:
- true: 利用する
- false: 利用しない
Default: true
redirect string 結果をリダイレクトするかどうか。省略可。
指定できる値:
- true: リダイレクトする
- false: リダイレクトせずURL文字列を返す
Default: false
contentsMode string 生成するURLの種類。省略可。
- pc: PC向け
- sp: スマートフォン向け
Default: pc

response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / ResourceURI 探索結果を表示する駅すぱあと for web のページへのURL文字列

example

GET /v1/xml/search/course/light?key=アクセスキーを入力してください&from=22828&to=25853
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201612_02a">
  <ResourceURI>http://roote.ekispert.net/result?arr=%E5%A4%A7%E9%98%AA&amp;arr_code=25853&amp;connect=true&amp;dep=%E6%9D%B1%E4%BA%AC&amp;dep_code=22828&amp;highway=true&amp;hour&amp;limitedExpress=true&amp;liner=true&amp;local=true&amp;minute&amp;plane=true&amp;shinkansen=true&amp;ship=true&amp;sleep=false&amp;sort=time&amp;surcharge=3&amp;type=dep&amp;via1=&amp;via1_code=&amp;via2=&amp;via2_code=</ResourceURI>
</ResultSet>
GET /v1/json/search/course/light?key=アクセスキーを入力してください&from=22828&to=25853
{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "201612_02a",
    "ResourceURI": "http://roote.ekispert.net/result?arr=%E5%A4%A7%E9%98%AA&arr_code=25853&connect=true&dep=%E6%9D%B1%E4%BA%AC&dep_code=22828&highway=true&hour&limitedExpress=true&liner=true&local=true&minute&plane=true&shinkansen=true&ship=true&sleep=false&sort=time&surcharge=3&type=dep&via1=&via1_code=&via2=&via2_code="
  }
}