運行路線情報

「駅すぱあと」の保持する運行路線の情報(鉄道のみ)を取得します。 codeを指定すると、指定した運行路線の情報を返します。 nameを指定すると、運行路線の前方一致による絞り込みを行います。部分一致検索をしたい場合はnameMatchTypeパラメータをご利用ください。

GET /v1/{format}/operationLine

parameters

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

Name	Type	Required	Description
format	string	◯	レスポンスのデータ形式の指定。必須。指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。
key	string	◯	アクセスキー。必須
code	string	---	運行路線コード。nameと排他。
name	string	---	運行路線名。codeと排他。
nameMatchType	string	---	マッチング方式の指定。nameパラメータ指定時のみ有効。省略可。 - forward : 前方一致 - partial : 部分一致 default: forward
corporationCode	string	---	会社コード。corporationNameと排他。省略可。省略時は全ての会社が対象となります。code指定時は無効となります。
corporationName	string	---	会社名。corporationCodeと排他。省略可。省略時は全ての会社が対象となります。code指定時は無効となります。
prefectureCode	int	---	都道府県コード。省略可。省略時は全国が対象となります。code指定時は無効となります。
offset	int	---	データの取得開始位置。code指定時無効です。省略可。 Default: 1
limit	int	---	データのブロック件数。code指定時無効です。指定可能な値は1から100です。省略可。 Default: 100

response

Name	Description
ResultSet	レスポンスの最下部を表す要素
ResultSet / apiVersion	WebAPIバージョン
ResultSet / engineVersion	エンジンバージョン
ResultSet / max	データの全件数。一度に取得できない場合は、offsetの指定を繰り上げて取得してください。
ResultSet / offset	データ開始位置のオフセット値
ResultSet / Corporation	会社を表す要素
ResultSet / Corporation / index	インデックス。 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項
ResultSet / Corporation / code	会社コード
ResultSet / Corporation / Name	名称を表す要素
ResultSet / Line	運行路線を表す要素
ResultSet / Line / corporationIndex	`ResultSet / Corporation / index`と紐づくインデックス
ResultSet / Line / code	運行路線コード
ResultSet / Line / Name	名称を表す要素
ResultSet / Line / Color	路線カラーを表す要素（10進数によるRGB形式） Format: RRRGGGBBB
ResultSet / Line / Yomi	読み仮名を表す要素

example

GET /v1/xml/operationLine?key=アクセスキーを入力してください

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" max="647" offset="1" engineVersion="201612_02a">
    <Corporation index="1" code="1">
        <Name>ＪＲ</Name>
    </Corporation>
    <Line corporationIndex="1" code="802">
        <Name>ＪＲ北海道新幹線</Name>
        <Yomi>じぇいあーるほっかいどうしんかんせん</Yomi>
        <Color>010140013</Color>
    </Line>
    <Line corporationIndex="1" code="134">
        <Name>ＪＲ東海道新幹線</Name>
        <Yomi>じぇいあーるとうかいどうしんかんせん</Yomi>
        <Color>001032197</Color>
    </Line>
    <Line corporationIndex="1">
      :
    </Line>
</ResultSet>

GET /v1/json/operationLine?key=アクセスキーを入力してください

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "max": "647",
    "offset": "1",
    "engineVersion": "201612_02a",
    "Corporation": {
      "code": "1",
      "Name": "ＪＲ"
    },
    "Line": [
      {
        "corporationIndex": "1",
        "code": "802",
        "Name": "ＪＲ北海道新幹線",
        "Yomi": "じぇいあーるほっかいどうしんかんせん",
        "Color": "010140013"
      },
      {
        "corporationIndex": "1",
        "code": "134",
        "Name": "ＪＲ東海道新幹線",
        "Yomi": "じぇいあーるとうかいどうしんかんせん",
        "Color": "001032197"
      },
      {
        :
      }
    ]
  }
}