鉄道路線形状取得

/transport_shape [GET]

基本情報

概要

鉄道の路線形状を出力することができます。

URL

https://{HOST}/{CID}/v1/transport_shape

出力形式

GeoJSON

対応言語

ja

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
link	✔	路線ID	文字列		最大10路線まで	ピリオド区切りで複数指定できます詳細はこちらをご覧ください
coord_unit		出力データに含まれる緯度経度の単位	文字列	degree	degree：度表記の10進法 millisec：ミリ秒表記

linkの取得方法について

「路線検索API(/transport_link)」のレスポンスにて返却される「路線ID(id)」を指定してください。
この時、リクエストパラメータに"type=train"を付与してリクエストしてください。

丸ノ内線のノードIDを取得したい場合

/v1/transport_link?word=丸ノ内線&type=train

パラメータ構成例

路線ID「00000766」「00000767」の路線形状情報を取得

/transport/shape?link=00000766.00000767

レスポンス

名称	レスポンス名	型名	配列	Nullable	説明
種別	type	文字列			"FeatureCollection"固定
形状に関する情報	features	Featuresオブジェクト
形状全体のバウンディングボックス	bbox	数値	〇	nullable

Featuresオブジェクト

名称	レスポンス名	型名	配列	説明
種別	type	文字列		"Feature"固定
形状全体のバウンディングボックス	bbox	数値	〇
形状の緯度経度情報	geometry	Geometryオブジェクト		形状の緯度経度情報
形状のメタ情報	properties	Propertyオブジェクト		形状のメタ情報

Geometryオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
種別	type	文字列			"LineString"固定
緯度経度	coordinate	Coordinateオブジェクト

Coordinateオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
緯度	lat	数値
経度	lon	数値

Propertyオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
路線ID	link	文字列		nullable
路線色	color	文字列		nullable	路線色を表すカラーコード

レスポンス例

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "bbox": [
        139.619445,
        35.699367,
        139.635774,
        35.704395
      ],
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            139.619445,
            35.704204
          ],
          ・・・
          [
            139.635774,
            35.699367
          ]
        ]
      },
      "properties": {
        "color": "#F62E36",
        "link": "00000766"
      }
    },
    ・・・
    {
      "type": "Feature",
      "bbox": [
        139.711766,
        35.725796,
        139.729911,
        35.730751
      ],
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            139.729911,
            35.725796
          ],
          ・・・
          [
            139.711766,
            35.730238
          ]
        ]
      },
      "properties": {
        "color": "#F62E36",
        "link": "00000766"
      }
    },
    {
      "type": "Feature",
      "bbox": [
        139.658234,
        35.68362,
        139.667213,
        35.690676
      ],
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            139.658234,
            35.68362
          ],
          ・・・
          [
            139.667213,
            35.690676
          ]
        ]
      },
      "properties": {
        "_order": 24,
        "order": 0,
        "route": 18743360,
        "link_color": "#F62E36",
        "link_id": "00000767"
      }
    },
    ・・・
  ]
   "bbox": [
    139.619445,
    35.672249,
    139.767541,
    35.730751
  ]
}

エラー情報

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

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

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: link: ['required field']	必須パラメータである link が指定されていない場合に発生します。
400	parameter error: link: ['an invalid code: {value}']	link にピリオド区切りで不正な路線IDを指定した場合に発生します。
400	too many links. maximum is 10.	link に11路線以上を指定した場合に発生します。
400	parameter error: coord_unit: ['unallowed value {value}']	coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。