範囲探索(旧版)

Attention!

This page has not been translated into English yet. It is possible that some parts of description may contains old information. Please see Japanese Documents if you need the latest and accurate information.

Attention!

より機能を拡張した範囲探索を公開しました。範囲探索(旧版)は互換性維持のために提供を続けておりますが、これから開発を始められる方は範囲探索をご利用いただくことを推奨します。

駅コードや駅の名称で指定された駅を起点とし、上限値(分)の範囲内の駅を探索します。乗換回数を指定された場合は、乗換回数を考慮した範囲探索を行います。

GET /v1/{format}/search/range

parameters

Name	Type	Description
format	string	レスポンスのデータ形式の指定。必須指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。
key	string	アクセスキー。必須
code	int	駅コード。nameと排他。交通種別がtrainのもののみ指定可能です。
name	string	駅の名称。codeと排他。交通種別がtrainのもののみ指定可能です。
upperLimit	int	所要時間の上限値。必須。10から200まで指定可能です。単位: 分
transferCount	int	乗換回数の上限値。省略可。省略時は乗換回数を考慮しません。 ※レスポンスの`ResultSet / Point / TransferCount`とは意味合いが異なり、乗換回数の上限値を指定するものであるため、実際のレスポンスには、乗り換え回数0回〜指定された回数までの駅が含まれます。
plane	string	飛行機。省略可指定できる値: - true: 利用する - false: 利用しない Default: true
shinkansen	string	新幹線(のぞみ含む)。省略可指定できる値: - true: 利用する - false: 利用しない Default: true
limitedExpress	string	特急。省略可指定できる値: - true: 利用する - false: 利用しない Default: true
limit	int	探索結果項目の最大件数。省略可。省略時は全件を対象とします。

response

Name	Description
ResultSet	レスポンスの最下部を表す要素
ResultSet / apiVersion	WebAPIバージョン
ResultSet / engineVersion	エンジンバージョン
ResultSet / Point	地点を表す要素
ResultSet / Point / Minute	起点からの時間を表す要素単位: 分
ResultSet / Point / TransferCount	起点からの乗換回数を表す要素 ※リクエストパラメータの`transferCount`とは意味合いが異なり、乗換回数の上限値ではなく、実際の経路での乗換回数を表します。
ResultSet / Point / Prefecture	都道府県を表す要素
ResultSet / Point / Prefecture / code	都道府県コード
ResultSet / Point / Prefecture / Name	都道府県の名称を表す要素
ResultSet / Point / Station / code	駅コード
ResultSet / Point / Station / Name	駅の名称を表す要素
ResultSet / Point / Station / Type	交通種別を表す要素

example

GET /v1/xml/search/range?key=アクセスキーを入力してください&code=22828&upperLimit=20

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Point>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Minute>5</Minute>
    <Station code="23036">
      <Name>有楽町</Name>
      <Type>train</Type>
    </Station>
    <TransferCount>0</TransferCount>
  </Point>
  <Point>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Minute>5</Minute>
    <Station code="22617">
      <Name>神田(東京都)</Name>
      <Type>train</Type>
    </Station>
    <TransferCount>0</TransferCount>
  </Point>
  <Point>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Minute>6</Minute>
    <Station code="22492">
      <Name>秋葉原</Name>
      <Type>train</Type>
    </Station>
    <TransferCount>0</TransferCount>
  </Point>
  <Point>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Minute>8</Minute>
    <Station code="22751">
      <Name>新橋</Name>
      <Type>train</Type>
    </Station>
    <TransferCount>0</TransferCount>
  </Point>
  <Point>
    <Prefecture code="13">
      <Name>東京都</Name>
    </Prefecture>
    <Minute>8</Minute>
    <Station code="22570">
      <Name>御徒町</Name>
      <Type>train</Type>
    </Station>
    <TransferCount>0</TransferCount>
  </Point>
  <Point>
  :
  </Point>
</ResultSet>

GET /v1/json/search/range?key=アクセスキーを入力してください&code=22828&upperLimit=20

{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Point": [
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Minute": "5",
        "Station": {
          "code": "23036",
          "Name": "有楽町",
          "Type": "train"
        },
        "TransferCount": "0"
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Minute": "5",
        "Station": {
          "code": "22617",
          "Name": "神田(東京都)",
          "Type": "train"
        },
        "TransferCount": "0"
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Minute": "6",
        "Station": {
          "code": "22492",
          "Name": "秋葉原",
          "Type": "train"
        },
        "TransferCount": "0"
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Minute": "8",
        "Station": {
          "code": "22751",
          "Name": "新橋",
          "Type": "train"
        },
        "TransferCount": "0"
      },
      {
        "Prefecture": {
          "code": "13",
          "Name": "東京都"
        },
        "Minute": "8",
        "Station": {
          "code": "22570",
          "Name": "御徒町",
          "Type": "train"
        },
        "TransferCount": "0"
      },
      {
        :
      }
    ]
  }
}