平均路線情報

「駅すぱあと」の保持する平均路線の情報を取得します。 nameを指定すると、名称の前方一致による絞り込みを行います。 oldNameを指定すると、新名称を取得できます。 corporationCodeもしくはcorporationNameを指定すると、指定した会社で絞り込みます。 fromとtoを指定した場合は、2点間を結ぶ平均路線が取得できます。 dateを指定すると、その日に運行している平均路線に絞り込めます。

GET /v1/{format}/rail

parameters

※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。

Name	Type	Required	Description
format	string	◯	レスポンスのデータ形式の指定。必須。指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。
key	string	◯	アクセスキー。必須
name	string	---	平均路線の名称（前方一致）。oldName, corporationCode, corporationName, from, toと排他。省略可
oldName	string	---	平均路線の旧名称。name, corporationCode, corporationName, from, toと排他。省略可
corporationCode	int	---	会社コード。name, oldName, corporationName, from, toと排他。省略可
corporationName	string	---	会社の名称。name, oldName, corporationCode, from, toと排他。省略可
from	string	△	駅コードまたは駅の名称。name, oldName, corporationCode, corporationNameと排他。to指定時に必須
to	string	△	駅コードまたは駅の名称。name, oldName, corporationCode, corporationNameと排他。from指定時に必須
prefectureCode	int	---	都道府県コード。省略可。省略時は全国が対象となります。
date	int	---	日付。省略可。省略時は全日付が対象となります。 Format: YYYYMMDD
type	string	---	交通種別。詳細路線種別を付加することができます。省略可。省略時は全種別が対象となります。指定できる値: - train: 鉄道 - plane: 航空
offset	int	---	データの取得開始位置。name指定時は無効となります。省略可。 Default: 1
limit	int	---	データのブロック件数。最大100件まで指定できます。name指定時は無効となります。省略可。 Default: 100

response

Name	Description
ResultSet	レスポンスの最下部を表す要素
ResultSet / apiVersion	WebAPIバージョン
ResultSet / engineVersion	エンジンバージョン
ResultSet / max	データの全件数。一度に取得できない場合は、offsetの指定を繰り上げて取得してください。
ResultSet / offset	データ開始位置のオフセット値
ResultSet / Corporation	会社を表す要素
ResultSet / Corporation / code	会社コード
ResultSet / Corporation / Name	会社の名称を表す要素
ResultSet / Corporation / index	インデックス ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項
ResultSet / Line	区間を表す要素
ResultSet / Line / code	短期的な利用を前提とした列車コード
ResultSet / Line / corporationIndex	`ResultSet / Corporation / index`と紐づくインデックス
ResultSet / Line / Color	路線カラーを表す要素（10進数によるRGB形式） Format: RRRGGGBBB
ResultSet / Line / Name	名称を表す要素
ResultSet / Line / Number	番号(号、便など)を表す要素
ResultSet / Line / OldName	旧名称を表す要素
ResultSet / Line / Type	交通種別を表す要素。 - train: 鉄道 - plane: 航空
ResultSet / Line / Type / detail	交通種別の詳細または詳細路線種別

example

会社を指定して平均路線一覧を取得する

GET /v1/xml/rail?key=アクセスキーを入力してください&corporationName=ＪＲ

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" max="447" offset="1" engineVersion="201612_02a">
  <Corporation index="1" code="1">
    <Name>ＪＲ</Name>
  </Corporation>
  <Line corporationIndex="1">
    <Name>ＪＲ新幹線のぞみ</Name>
    <Type detail="shinkansen">train</Type>
    <Color>051102255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>ＪＲ新幹線ひかり(東京－博多)</Name>
    <Type detail="shinkansen">train</Type>
    <Color>001044255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>ＪＲ新幹線こだま(東京－新大阪)</Name>
    <Type detail="shinkansen">train</Type>
    <Color>001044255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>ＪＲ新幹線こだま(新大阪－博多)</Name>
    <Type detail="shinkansen">train</Type>
    <Color>001044255</Color>
  </Line>
  <Line corporationIndex="1">
    <Name>ＪＲ新幹線はやぶさ</Name>
    <Type detail="shinkansen">train</Type>
    <Color>000208030</Color>
  </Line>
    :
  </Line>
</ResultSet>

GET /v1/json/rail?key=アクセスキーを入力してください&corporationName=ＪＲ

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "max": "447",
    "offset": "1",
    "engineVersion": "201612_02a",
    "Corporation": {
      "code": "1",
      "Name": "ＪＲ"
    },
    "Line": [
      {
        "corporationIndex": "1",
        "Name": "ＪＲ新幹線のぞみ",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "051102255"
      },
      {
        "corporationIndex": "1",
        "Name": "ＪＲ新幹線ひかり(東京－博多)",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "001044255"
      },
      {
        "corporationIndex": "1",
        "Name": "ＪＲ新幹線こだま(東京－新大阪)",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "001044255"
      },
      {
        "corporationIndex": "1",
        "Name": "ＪＲ新幹線こだま(新大阪－博多)",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "001044255"
      },
      {
        "corporationIndex": "1",
        "Name": "ＪＲ新幹線はやぶさ",
        "Type": {
          "text": "train",
          "detail": "shinkansen"
        },
        "Color": "000208030"
      },
      {
        :
      }
    ]
  }
}

旧名称から新名称を取得する

GET /v1/xml/rail?key=アクセスキーを入力してください&oldName=近鉄奈良線快急

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="201612_02a">
  <Line>
    <OldName>近鉄奈良線快急</OldName>
    <Name>近鉄奈良線快速急行</Name>
  </Line>
</ResultSet>

GET /v1/json/rail?key=アクセスキーを入力してください&oldName=近鉄奈良線快急

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "201612_02a",
    "Line": {
      "OldName": "近鉄奈良線快急",
      "Name": "近鉄奈良線快速急行"
    }
  }
}