インタフェース仕様

探索条件生成

概要

経路探索に利用する探索条件を生成します。

リクエストパラメータ

パラメータ名 必須 説明
tenantId string テナントID
localeId string ロケールID
companyCode   string 会社コード
companyName   string 会社名
organizationSetCode   string 組織セットコード
organizationSetName   string 組織セット名(組織セットコードに紐付く組織名)
organizationCode   string 組織コード
organizationName   string 組織名
userCode   string ユーザーコード
userName   string ユーザー名
detail   string 詳細探索条件データ(省略可)
plane   string 飛行機(省略可)
shinkansen   string 新幹線(省略可)
shinkansenNozomi   string 新幹線のぞみ(省略可)
sleeperTrain   string 寝台列車(省略可)
limitedExpress   string 有料特急(省略可)
highwayBus   string 高速バス(省略可)
connectionBus   string 連絡バス(省略可)
localBus   string 路線バス(省略可)
midnightBus   string 深夜急行バス(省略可)
ship   string 船(省略可)
liner   string 有料普通列車(省略可)
walk   string 駅間徒歩(省略可)
useJR   string JR路線(省略可)
transfer   string 乗換え(省略可)
waitAverageTime   string 出発駅乗車待ち平均時間の利用(省略可)
expressStartingStation   string 特急始発駅(省略可)
localBusOnly   string 路線バスのみ探索(省略可)
transferTime   string 乗換え時間(省略可)
fuzzyLine   string 路線名あいまい指定(省略可)
entryPathBehavior   string 経由駅指定の継承(省略可)
surchargeKind   string 特急料金種別希望初期値(省略可)
teikiKind   string 定期種別初期値(省略可)
JRSeasonalRate   string JR季節料金(省略可)
studentDiscount   string 学割乗車券(省略可)
airFare   string 航空運賃の指定(省略可)
includeInsurance   string 航空保険特別料金(省略可)
ticketSystemType   string 乗車券計算のシステム(省略可)
nikukanteiki   string 2区間定期(だぶるーと,JR2区間定期)の利用(省略可)

レスポンスパラメータ

パラメータ名 説明
ResultSet  
  apiVersion 駅すぱあとAPIのバージョン
  engineVersion 駅すぱあとAPIエンジンのバージョン
  Condition 詳細探索条件を表す要素
  ErrorInfo  
    errorCode エラーコード
    errorMessage エラーメッセージ
    errorMessageDetail エラーメッセージ詳細

コラム

各パラメータの詳細は、「 駅すぱあとWebサービスのAPIドキュメント<http://api.ekispert.jp/doc/api/toolbox/course/condition.html> 」を参照してください。

経路探索

概要

指定された駅もしくは地点間の、公共交通機関を利用した経路を探索します。

リクエストパラメータ

パラメータ名 必須 説明
tenantId string テナントID
localeId string ロケールID
companyCode   string 会社コード
companyName   string 会社名
organizationSetCode   string 組織セットコード
organizationSetName   string 組織セット名(組織セットコードに紐付く組織名)
organizationCode   string 組織コード
organizationName   string 組織名
userCode   string ユーザーコード
userName   string ユーザー名
viaList   string 駅名のリスト (複数指定可。区切り文字はコロン「:」)
fixedRailList   string 固定路線の名称リスト(省略可)
fixedRailDirectionList   string 固定路線の方向リスト(省略可)
date   int 探索日付(YYYYMMDD) (省略可)
time   int 探索時刻(HHMM) (省略可)
searchType   string 探索種別 (省略可)
sort   string ソート種別(省略可)
answerCount   int 最大回答数。最大20 (省略可)
searchCount   int 最大探索数。最大20 (省略可)
conditionDetail   string 詳細探索条件データ。探索条件生成から取得できる (省略可)
corporationBind   string 固定会社名(複数指定可)
interruptCorporationList   string 不通会社リスト(省略可)
interruptRailList   string 不通路線リスト(省略可)
resultDetail   string 結果に詳細情報を付加します(省略可)
assignRoute   string 定期割り当て用経路文字列(省略可。assignDetailRouteと排他)
assignDetailRoute   string 定期割り当て用詳細経路文字列(省略可。assignRouteと排他)
assignNikukanteikiIndex   int 定期割り当て用経路が二区間定期の場合、その状態を表すPassStatusのindexを指定します。(複数指定可)
coupon   string 割り当て回数券詳細名称 (省略可)
bringAssignmentError   string 割り当てエラーの場合にエラーとする(省略可)

レスポンスパラメータ

パラメータ名 説明
ResultSet  
  apiVersion 駅すぱあとAPIのバージョン
  engineVersion 駅すぱあとAPIエンジンのバージョン
  Course 経路探索の結果である経路を表す要素
    dataType 時刻を元にした探索結果かどうか
    searchType 探索種別
    PassStatus 定期の状態を表す要素
      index インデックス
      kind 状態の種類
      selected 選択状態
      teiki1Index この要素が状態を表している1ヶ月定期のインデックス
      teiki3Index この要素が状態を表している3ヶ月定期のインデックス
      teiki6Index この要素が状態を表している6ヶ月定期のインデックス
      Comment コメント文字列を表す要素
      Name 名称を表す要素
      Type 種別を表す要素
    Price 金額を表す要素
      fromLineIndex 開始区間インデックス
      index インデックス
      kind 金額種別
      nikukanteikiIndex 定期の二区間定期(だぶるーと含む)情報インデックス
      relationIndex 関係インデックス
      selected 選択状態(合計金額の計算に含まれているかどうか)
      toLineIndex 終了区間インデックス
      vehicleIndex 定期の車両情報インデックス
      Name 名称を表す要素
      Oneway 片道を表す要素
        fullRemark 詳細な追加情報
        remark 追加情報
      Rate 繁忙・閑散期を表す要素
        area JRの繁忙・閑散期の区分
      Round 往復を表す要素
        fullRemark 詳細な追加情報
        remark 追加情報
      Type 種類を表す要素
    Relation 関係を表す要素
      index インデックス
      Name 名称を表す要素
      PriceRelation 金額の関係を表す要素
        index インデックス
        kind 金額種別
    Route 経路探索結果の経路のみを表す要素
      distance 経路の距離 (単位:100m)
      exhaustCO2 経路の総二酸化炭素排出量 (単位:g)
      exhaustCO2atPassengerCar マイカーを利用したと仮定した時の二酸化炭素の排出量 (単位:g)
      index インデックス
      timeOnBoard 経路の乗車時間合計 (単位:分)
      timeOther 経路のその他時間合計 (単位:分)
      timeWalk 経路の徒歩時間合計 (単位:分)
      transferCount 経路の乗り換え回数合計
      Line 区間を表す要素
        chargeIndex 料金インデックス
        direction 路線の方向
        distance 区間の距離 (単位:100m)
        exhaustCO2 二酸化炭素の排出量(単位:g)
        exhaustCO2atPassengerCar 鉄道や飛行機の区間をマイカーを利用したと仮定した時の二酸化炭素の排出量(単位:g)
        fareIndex 運賃インデックス
        index インデックス
        stopStationCount 列車が停止する駅の数
        teiki1Index 1ヶ月定期代インデックス
        teiki3Index 3ヶ月定期代インデックス
        teiki6Index 6ヶ月定期代インデックス
        timeOnBoard 区間の乗車時間合計 (単位:分)
        ArrivalState 到着時の状態を表す要素
          no 到着番線、番号等
          Datetime 日時を表す要素
            operation 運行日判定
          Type 駅の状態を表す要素
        Color 色を表す要素
        DepartureState 出発時の状態を表す要素
          no 出発番線、番号等
          Datetime 日時を表す要素
            operation 運行日判定
          Type 駅の状態を表す要素
        Destination 列車の行き先を表す要素
        Name 名称を表す要素
        Number 番号(号、便など)を表す要素
        TimeReliability 発着時刻の信頼度を表す要素
        Type 詳細路線種別を表す要素
          detail 交通種別の詳細(busのみ)
        TypicalName 代表名称を表す要素
      Point 地点を表す要素
        index インデックス
        GeoPoint 座標を表す要素
          gcs 測地系
          lati 緯度 (度.分.秒.100分の1秒)
          lati_d 緯度 (度)
          longi 経度 (度.分.秒.100分の1秒)
          longi_d 経度 (度)
        Prefecture 都道府県を表す要素
          code 都道府県コード
          Name 名称を表す要素
        Station 駅を表す要素
          code 駅コード
          Name 名称を表す要素
          Type 交通種別を表す要素
            detail 交通種別の詳細(busのみ)
          Yomi 読みかなを表す要素
    SerializeData 経路復元情報(経路シリアライズデータ)を表す要素
  ErrorInfo  
    errorCode エラーコード
    errorMessage エラーメッセージ
    errorMessageDetail エラーメッセージ詳細

コラム

各パラメータの詳細は、「 駅すぱあとWebサービスのAPIドキュメント<http://api.ekispert.jp/doc/api/search/course/extreme.html> 」を参照してください。

駅簡易情報

概要

指定された条件に当てはまる駅の情報を返します。

リクエストパラメータ

パラメータ名 必須 説明
tenantId string テナントID
localeId string ロケールID
companyCode   string 会社コード
companyName   string 会社名
organizationSetCode   string 組織セットコード
organizationSetName   string 組織セット名(組織セットコードに紐付く組織名)
organizationCode   string 組織コード
organizationName   string 組織名
userCode   string ユーザーコード
userName   string ユーザー名
name   string 候補文字列(codeと排他)
code   int 駅すぱあとの駅コード(nameと排他)
type   string 駅の路線の交通種別 (複数指定可、省略可)
prefectureCode   int 都道府県コード(code指定時は無効)
corporationBind   string 固定会社名(複数指定可、省略可)

レスポンスパラメータ

パラメータ名 説明
ResultSet  
  apiVersion 駅すぱあとAPIのバージョン
  engineVersion 駅すぱあとAPIエンジンのバージョン
  Point 地点を表す要素
    Prefecture 都道府県を表す要素
      code 都道府県コード
      Name 名称を表す要素
    Station 駅を表す要素
      code 駅コード
      Type 交通種別を表す要素
        detail 交通種別の詳細(busのみ)
      Name 名称を表す要素
      Yomi 読みかなを表す要素
  ErrorInfo  
    errorCode エラーコード
    errorMessage エラーメッセージ
    errorMessageDetail エラーメッセージ詳細

コラム

各パラメータの詳細は、「 駅すぱあとWebサービスのAPIドキュメント<http://api.ekispert.jp/doc/api/station/light.html> 」を参照してください。