コンテンツにスキップ

駅出口検索

/transport_node/gateway [GET]

基本情報

概要

駅ID、路線ID、上下区分を指定して駅出口の情報を取得します。

URL

https://{HOST}/{CID}/v1/transport_node/gateway

※APIマーケットの場合はURL体系が異なります

出力形式

  • JSON

対応言語

  • ja

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
node ✔ ノードID 文字列
link ✔ 路線ID 文字列
direction ✔ 路線の上下区分 文字列 up：上り
down：下り
offset データの出力開始位置 数値 0 最小値：0
最大値：1000		 何件目から表示されるか（1件目が0）を指定します
対象要素は items です
limit データの出力件数 数値 10 最小値：1
最大値：100		 駅出口データの出力件数
datum 緯度経度の測地系 文字列 wgs84 wgs84：世界測地系
tokyo：旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree：度表記の10進法
millisec：ミリ秒表記

パラメータ構成例

  • 東京メトロ銀座線上り方面、表参道駅の出口情報を取得
/transport_node/gateway?node=00007820&link=00000768&direction=up

レスポンス

名称 レスポンス名 型名 配列 Nullable 説明
検索数 count Countオブジェクト
ノード情報 node Nodeオブジェクト
路線情報 link Linkオブジェクト nullable
路線情報 items Gatewayオブジェクト 〇 nullable 駅出口情報のまとまり
単位情報 unit Unitオブジェクト 出力される単位の情報

Countオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Nodeオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
駅のノードID id 文字列
駅の名称 name 文字列
駅の名称の読み仮名 ruby 文字列 nullable
駅の緯度経度 coord Coordinateオブジェクト

Coordinateオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
緯度 lat 数値
経度 lon 数値
名称 レスポンス名 型名 配列 Nullable 説明
路線ID id 文字列
路線の名称 name 文字列
運行会社情報 company Companyオブジェクト

Companyオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
運行会社ID id 文字列
運行会社の名称 name 文字列

Gatewayオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
駅出口の緯度経度 coord Coordinateオブジェクト
駅出口の名称 name 文字列
降車推奨位置 getoff 文字列 nullable 例えば1号車/6号車の場合は「1・6」と出力する

Unitオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
測地系 datum 文字列 nullable
緯度経度の出力形式 coord_unit 文字列 nullable

レスポンス例

{
    "count": {
        "total": 10,
        "offset": 0,
        "limit": 10
    },
    "node": {
        "id": "00007820",
        "name": "表参道",
        "ruby": "おもてさんどう",
        "coord": {
            "lon": 139.712604,
            "lat": 35.665295
        }
    },
    "link": {
        "id": "00000768",
        "name": "東京メトロ銀座線",
        "company": {
            "id": "00000113",
            "name": "東京地下鉄（メトロ）"
        }
    },
    "items": [
        {
            "coord": {
                "lat": 35.665815,
                "lon": 139.710728
            },
            "name": "A1口",
            "getoff": "1・6"
        },
        {
            "coord": {
                "lat": 35.664935,
                "lon": 139.713027
            },
            "name": "A4口",
            "getoff": "1・6"
        },
        ・・・
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス エラーメッセージ 発生理由
405 This http method is invalid : POST (等) 許可されていないHTTPメソッドでアクセスされた場合に発生します。
400 parameter error: node: ['required field'] 必須パラメータである node が指定されていない、または空文字の場合に発生します。
400 parameter error: node: ['an invalid code: {value}'] node に不正なノードIDを指定した場合に発生します。
400 parameter error: link: ['required field'] 必須パラメータである link が指定されていない、または空文字の場合に発生します。
400 parameter error: link: ['an invalid code: {value}'] link に不正な路線IDを指定した場合に発生します。
400 parameter error: direction: ['required field'] 必須パラメータである direction が指定されていない、または空文字の場合に発生します。
400 parameter error: direction: ['unallowed value {value}'] direction に up, down 以外の不正な値を指定した場合に発生します。
400 parameter error: offset: ['min value is 0'] offset に0未満の値を指定した場合に発生します。
400 parameter error: offset: ['max value is 1000'] offset に1000を超える値を指定した場合に発生します。
400 parameter error: limit: ['min value is 1'] limit に1未満の値を指定した場合に発生します。
400 parameter error: limit: ['max value is 100'] limit に100を超える値を指定した場合に発生します。
400 parameter error: datum: ['unallowed value {value}'] datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。
400 parameter error: coord_unit: ['unallowed value {value}'] coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。