経路探索結果のシェイプ情報
経路探索結果(経路シリアライズデータ)から、経路のシェイプ情報(地図に経路をポリライン描画するための情報)を取得します。
レスポンスとしては、経路の区間(ResultSet / Course / Route / Line
)とインデックスで紐づく運行路線パターン(ResultSet / Course / OperationLinePattern
)の区間毎にシェイプポイントの情報が返ります。
鉄道の区間のシェイプ情報を使用してポリライン描画すると、線路に沿ったなめらかな曲線となります。データソース等につきましては、シェイプ情報の提供元をご確認ください。
鉄道以外の区間については、通過駅または停車駅の粒度のシェイプ情報となるため、鉄道と比較して直線的になります。
※ポリライン描画のイメージ図など、詳しくは探索結果からシェイプ情報を取得するをご確認ください。
note
経路探索では鉄道以外の区間には運行路線パターンが返りませんが、シェイプ情報では駅間の徒歩を含むすべての交通種別の区間で運行路線パターンが取得できます。
Attention!
出発駅や到着駅に座標情報、住所情報、または地点データを指定した経路探索結果の場合、その地点から駅までの区間には運行路線パターンは返りません。
平均待ち時間による探索の経路シリアライズデータは利用できません。
平均待ち時間による探索の経路シリアライズデータは利用できません。
GET /v1/{format}/course/shape
parameters
※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。
Name | Type | Required | Description |
---|---|---|---|
format | string | ◯ | レスポンスのデータ形式の指定。必須 Values: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。 |
key | string | ◯ | アクセスキーの指定。必須 |
serializeData | string | ◯ | 経路シリアライズデータ。必須 |
checkEngineVersion | string | --- | 完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。 指定できる値: - true: チェックする - false: チェックしない Default: true |
type | string | --- | シェイプ情報を取得する交通種別の指定。省略可。 指定できる値: - train: 鉄道のみ - all: すべての交通種別 Default: train |
response
Name | Description |
---|---|
ResultSet / apiVersion | WebAPIバージョン |
ResultSet / engineVersion | エンジンバージョン |
ResultSet / Course | 経路探索の結果である経路を表す要素 |
ResultSet / Course / dataType | 時刻を元にした探索結果かどうか。 - onTimetable: 時刻に基づく探索 |
ResultSet / Course / OperationLinePattern | 経路の区間に紐づく運行路線パターンを表す要素。 ※ OperationLinePattern は複数返る可能性があります。※ 経路の区間が鉄道以外の交通種別(徒歩を含む)の場合も返ります。 ※ 出発駅や到着駅に座標情報、住所情報、または地点データを指定した経路探索結果の場合、その地点から駅までの区間に紐付く OperationLinePattern は返りません。 |
ResultSet / Course / OperationLinePattern / routeLineIndex | ResultSet / Course / Route / Line /index と紐づくインデックス |
ResultSet / Course / OperationLinePattern / Point | 地点 を表す要素 |
ResultSet / Course / OperationLinePattern / Point / index | インデックス。 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
ResultSet / Course / OperationLinePattern / Point / Station | 駅を表す要素 |
ResultSet / Course / OperationLinePattern / Point / Station / code | 駅コード |
ResultSet / Course / OperationLinePattern / Point / Station / Name | 駅の名称を表す要素 |
ResultSet / Course / OperationLinePattern / Point / Station / Type | 交通種別を表す要素 |
ResultSet / Course / OperationLinePattern / Point / Station / Yomi | 駅の読みかなを表す要素 |
ResultSet / Course / OperationLinePattern / Point / Prefecture | 都道府県を表す要素 |
ResultSet / Course / OperationLinePattern / Point / Prefecture / code | 都道府県コード |
ResultSet / Course / OperationLinePattern / Point / Prefecture / Name | 都道府県の名称を表す要素 |
ResultSet / Course / OperationLinePattern / Line | 路線を表す要素 ※ 鉄道の場合は運行路線になります。 ※ 鉄道以外の場合は平均路線になります。 |
ResultSet / Course / OperationLinePattern / Line / index | インデックス。 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
ResultSet / Course / OperationLinePattern / Line / code | 運行路線コード ※ 鉄道のみ返ります。 |
ResultSet / Course / OperationLinePattern / Line / direction | 方向 |
ResultSet / Course / OperationLinePattern / Line / fromStationPos | 区間発駅番号 ※ 鉄道のみ返ります。 |
ResultSet / Course / OperationLinePattern / Line / toStationPos | 区間着駅番号 ※ 鉄道のみ返ります。 |
ResultSet / Course / OperationLinePattern / Line / track | 軌道種別 ※ 鉄道のみ返ります。 |
ResultSet / Course / OperationLinePattern / Line / Color | 路線カラーを表す要素(10進数によるRGB形式) Format: RRRGGGBBB |
ResultSet / Course / OperationLinePattern / Line / Name | 路線の名称を表す要素 |
ResultSet / Course / OperationLinePattern / Line / Shape | シェイプポイントを表す要素 ※ Shape は複数返る可能性があります。※ 徒歩区間のように、現時点では2つしか返らない場合でも今後増える可能性があります。 |
ResultSet / Course / OperationLinePattern / Line / Shape / index | シェイプポイントの連結順序 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
ResultSet / Course / OperationLinePattern / Line / Shape / GeoPoint | 座標を表す要素 |
ResultSet / Course / OperationLinePattern / Line / Shape / GeoPoint / gcs | 測地系 - wgs84: 世界測地系 ※ gcsパラメータでの測地系変換には未対応です。 |
ResultSet / Course / OperationLinePattern / Line / Shape / GeoPoint / lati_d | 緯度。十進法度(DD)単位。 Format: 度 Example: 35.701667 |
ResultSet / Course / OperationLinePattern / Line / Shape / GeoPoint / longi_d | 経度。十進法度(DD)単位。 Format: 度 Example: 139.639527 |
ResultSet / Course / OperationLinePattern / Line / Type | 交通種別を表す要素 |
ResultSet / Course / OperationLinePattern / Line / Type / detail | 交通種別の詳細を表す要素 ※ バスのみ返ります。 ※ detailには鉄道の詳細路線種別は返りません。 |
example
GET /v1/xml/course/shape?key=アクセスキーを入力してください&serializeData=VkV4QaECp5bKAsMCpgE0s4cDpgE0s1sEksIBQwAAAAKmATSzW8IBQwgBAgKmATSzWgPKAQECAQMBBAEHAQgBCgIPQv9_EKX_9xSSpViPpVkGBJLCAmMzNS43MDkzMzYxNDQsMTM5LjY1NjkxOTA0Nyx0b2t5bywyMAaRwwGlsz0DRJNrleAEPMICTpKFg4mDk4Nog32BW4NOBpHDAaVZPANEk2uV4ASlASwFncIBBAIBwQKlsz3BAqWySMECpViPwQKlWQbBAqVZPMIBBAICwQKlV4HBAqVZysECpVYswQKlWPDBAqWy5cECpVlBBpXCAQMCD8MBAgIGA8UBpQFlAg0DDwSlAn0GAcMBAwIFA8IBAQMBwwEBAgEDxwGlS14CBgMJBaR5BkUxNjA0WQcICAfDAQECAQPHAaYAAftCAgIDBAWkeQZENTgwOQcKCAkHlsUBpgE0s3EDpQPEBKUDxQUACADGAaYBNLNxAgEDpQPGBKUD1AUACADGAaYBNLNxAgIDpQPVBKUD1gUACADGAaYBNLNxAgMDpQPZBKUD4gUACADGAaYBNLNxAgQDpQPtBKUD8QUACADFAaYBNLNxA6UD8gSlA_cFAAgACJfEAQQEAQUEBwDHAgEEAgUCBgIHpQE|CAsJUIrWk4yDb4NYgUWNgoJVgk_FAgIEAwUCBwEJRJNrleDFAgMEDAUBB6RuCAzGAgwEBAUBBgEHpQFLCATGAgQEBQUBBgEHpQEgCAXFAgUDBAQGBQQHAAmTwwEBAgEDAcMBAwIDAwHDAQQCBAMBCpPDAQECAQMJwgEDAgPCAQQCBA|RxgGXAAECAwQFBgKWwwEAAgADAMMBAQIBAwHDAQICAgMCwwEDAgMDBMMBBAIFAwXDAQUCBgMGA5fDAQACAAMAwwEBAgEDAcMBAgICAwLDAQMCAwMDwwEEAgMDA8MBBQIEAwTDAQYCBQMFBJMAAQIFkQAKAA**--T32212332323191:F33211221200001:A23121141:--f75b3d6f509d94308f8b115345d67f924be79f07--1--1--1--730&checkEngineVersion=false&type=all
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="202311_02a">
<Course dataType="onTimetable">
<OperationLinePattern routeLineIndex="2">
<Point index="1">
<Station code="45885">
<Name>野方二丁目/関東バス</Name>
<Type detail="local">bus</Type>
<Yomi>のがたにちょうめ</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
<Line direction="Up" index="1">
<Name>関東バス・高60</Name>
<Shape index="1">
<GeoPoint longi_d="139.65385" lati_d="35.712585" gcs="wgs84" />
</Shape>
<Shape index="2">
<GeoPoint longi_d="139.65416" lati_d="35.709693" gcs="wgs84" />
</Shape>
:
<Shape index="4">
<GeoPoint longi_d="139.650049" lati_d="35.705778" gcs="wgs84" />
</Shape>
<Type detail="local">bus</Type>
<Color>255028026</Color>
</Line>
<Point index="2">
<Station code="45640">
<Name>高円寺駅北口/関東バス</Name>
<Type detail="local">bus</Type>
<Yomi>こうえんじえききたぐち</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
</OperationLinePattern>
<OperationLinePattern routeLineIndex="3">
<Point index="1">
<Station code="45640">
<Name>高円寺駅北口/関東バス</Name>
<Type detail="local">bus</Type>
<Yomi>こうえんじえききたぐち</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
<Line direction="Up" index="1">
<Name>徒歩</Name>
<Shape index="1">
<GeoPoint longi_d="139.650049" lati_d="35.705778" gcs="wgs84" />
</Shape>
<Shape index="2">
<GeoPoint longi_d="139.649826" lati_d="35.705333" gcs="wgs84" />
</Shape>
<Type>walk</Type>
<Color>230230230</Color>
</Line>
<Point index="2">
<Station code="22671">
<Name>高円寺</Name>
<Type>train</Type>
<Yomi>こうえんじ</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
</OperationLinePattern>
<OperationLinePattern routeLineIndex="4">
<Point index="1">
<Station code="22671">
<Name>高円寺</Name>
<Type>train</Type>
<Yomi>こうえんじ</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
<Line direction="Up" track="railway" toStationPos="420" index="1" fromStationPos="430" code="110">
<Name>JR中央・総武線各駅停車</Name>
<Type>train</Type>
<Color>255222000</Color>
<Shape index="1">
<GeoPoint longi_d="139.6497" lati_d="35.70532406" gcs="wgs84" />
</Shape>
<Shape index="2">
<GeoPoint longi_d="139.64992" lati_d="35.70533" gcs="wgs84" />
</Shape>
:
<Shape index="12">
<GeoPoint longi_d="139.666085" lati_d="35.705555" gcs="wgs84" />
</Shape>
</Line>
<Point index="2">
<Station code="22849">
<Name>中野(東京都)</Name>
<Type>train</Type>
<Yomi>なかの</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
<Line direction="Down" track="railway" toStationPos="120" index="2" fromStationPos="100" code="331">
<Name>東京メトロ東西線</Name>
<Type>train</Type>
<Color>000175239</Color>
<Shape index="1">
<GeoPoint longi_d="139.665605" lati_d="35.70574" gcs="wgs84" />
</Shape>
<Shape index="2">
<GeoPoint longi_d="139.66688" lati_d="35.70579" gcs="wgs84" />
</Shape>
:
<Shape index="54">
<GeoPoint longi_d="139.705045" lati_d="35.71328" gcs="wgs84" />
</Shape>
</Line>
<Point index="3">
<Station code="22790">
<Name>高田馬場</Name>
<Type>train</Type>
<Yomi>たかだのばば</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
</Point>
</OperationLinePattern>
<OperationLinePattern routeLineIndex="5">
:
</OperationLinePattern>
</Course>
</ResultSet>
GET /v1/json/course/shape?key=アクセスキーを入力してください&serializeData=VkV4QaECp5bKAsMCpgE0s4cDpgE0s1sEksIBQwAAAAKmATSzW8IBQwgBAgKmATSzWgPKAQECAQMBBAEHAQgBCgIPQv9_EKX_9xSSpViPpVkGBJLCAmMzNS43MDkzMzYxNDQsMTM5LjY1NjkxOTA0Nyx0b2t5bywyMAaRwwGlsz0DRJNrleAEPMICTpKFg4mDk4Nog32BW4NOBpHDAaVZPANEk2uV4ASlASwFncIBBAIBwQKlsz3BAqWySMECpViPwQKlWQbBAqVZPMIBBAICwQKlV4HBAqVZysECpVYswQKlWPDBAqWy5cECpVlBBpXCAQMCD8MBAgIGA8UBpQFlAg0DDwSlAn0GAcMBAwIFA8IBAQMBwwEBAgEDxwGlS14CBgMJBaR5BkUxNjA0WQcICAfDAQECAQPHAaYAAftCAgIDBAWkeQZENTgwOQcKCAkHlsUBpgE0s3EDpQPEBKUDxQUACADGAaYBNLNxAgEDpQPGBKUD1AUACADGAaYBNLNxAgIDpQPVBKUD1gUACADGAaYBNLNxAgMDpQPZBKUD4gUACADGAaYBNLNxAgQDpQPtBKUD8QUACADFAaYBNLNxA6UD8gSlA_cFAAgACJfEAQQEAQUEBwDHAgEEAgUCBgIHpQE|CAsJUIrWk4yDb4NYgUWNgoJVgk_FAgIEAwUCBwEJRJNrleDFAgMEDAUBB6RuCAzGAgwEBAUBBgEHpQFLCATGAgQEBQUBBgEHpQEgCAXFAgUDBAQGBQQHAAmTwwEBAgEDAcMBAwIDAwHDAQQCBAMBCpPDAQECAQMJwgEDAgPCAQQCBA|RxgGXAAECAwQFBgKWwwEAAgADAMMBAQIBAwHDAQICAgMCwwEDAgMDBMMBBAIFAwXDAQUCBgMGA5fDAQACAAMAwwEBAgEDAcMBAgICAwLDAQMCAwMDwwEEAgMDA8MBBQIEAwTDAQYCBQMFBJMAAQIFkQAKAA**--T32212332323191:F33211221200001:A23121141:--f75b3d6f509d94308f8b115345d67f924be79f07--1--1--1--730&checkEngineVersion=false&type=all
{
"ResultSet": {
"apiVersion": "1.27.0.0",
"engineVersion": "202311_02a",
"Course": {
"dataType": "onTimetable",
"OperationLinePattern": [
{
"routeLineIndex": "2",
"Line": {
"direction": "Up",
"Name": "関東バス・高60",
"Shape": [
{
"GeoPoint": {
"longi_d": "139.65385",
"lati_d": "35.712585",
"gcs": "wgs84"
}
},
{
"GeoPoint": {
"longi_d": "139.65416",
"lati_d": "35.709693",
"gcs": "wgs84"
}
},
:
{
"GeoPoint": {
"longi_d": "139.650049",
"lati_d": "35.705778",
"gcs": "wgs84"
}
}
],
"Type": {
"text": "bus",
"detail": "local"
},
"Color": "255028026"
},
"Point": [
{
"Station": {
"code": "45885",
"Name": "野方二丁目/関東バス",
"Type": {
"text": "bus",
"detail": "local"
},
"Yomi": "のがたにちょうめ"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
},
{
"Station": {
"code": "45640",
"Name": "高円寺駅北口/関東バス",
"Type": {
"text": "bus",
"detail": "local"
},
"Yomi": "こうえんじえききたぐち"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
}
]
},
{
"routeLineIndex": "3",
"Line": {
"direction": "Up",
"Name": "徒歩",
"Shape": [
{
"GeoPoint": {
"longi_d": "139.650049",
"lati_d": "35.705778",
"gcs": "wgs84"
}
},
{
"GeoPoint": {
"longi_d": "139.649826",
"lati_d": "35.705333",
"gcs": "wgs84"
}
}
],
"Type": "walk",
"Color": "230230230"
},
"Point": [
{
"Station": {
"code": "45640",
"Name": "高円寺駅北口/関東バス",
"Type": {
"text": "bus",
"detail": "local"
},
"Yomi": "こうえんじえききたぐち"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
},
{
"Station": {
"code": "22671",
"Name": "高円寺",
"Type": "train",
"Yomi": "こうえんじ"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
}
]
},
{
"routeLineIndex": "4",
"Line": [
{
"direction": "Up",
"track": "railway",
"toStationPos": "420",
"fromStationPos": "430",
"code": "110",
"Name": "JR中央・総武線各駅停車",
"Shape": [
{
"GeoPoint": {
"longi_d": "139.6497",
"lati_d": "35.70532406",
"gcs": "wgs84"
}
},
{
"GeoPoint": {
"longi_d": "139.64992",
"lati_d": "35.70533",
"gcs": "wgs84"
}
},
:
{
"GeoPoint": {
"longi_d": "139.666085",
"lati_d": "35.705555",
"gcs": "wgs84"
}
}
],
"Type": "train",
"Color": "255222000"
},
{
"direction": "Down",
"track": "railway",
"toStationPos": "120",
"fromStationPos": "100",
"code": "331",
"Name": "東京メトロ東西線",
"Shape": [
{
"GeoPoint": {
"longi_d": "139.665605",
"lati_d": "35.70574",
"gcs": "wgs84"
}
},
{
"GeoPoint": {
"longi_d": "139.66688",
"lati_d": "35.70579",
"gcs": "wgs84"
}
},
:
{
"GeoPoint": {
"longi_d": "139.705045",
"lati_d": "35.71328",
"gcs": "wgs84"
}
}
],
"Type": "train",
"Color": "000175239"
}
],
"Point": [
{
"Station": {
"code": "22671",
"Name": "高円寺",
"Type": "train",
"Yomi": "こうえんじ"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
},
{
"Station": {
"code": "22849",
"Name": "中野(東京都)",
"Type": "train",
"Yomi": "なかの"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
},
{
"Station": {
"code": "22790",
"Name": "高田馬場",
"Type": "train",
"Yomi": "たかだのばば"
},
"Prefecture": {
"code": "13",
"Name": "東京都"
}
}
]
},
{
"routeLineIndex": "5",
"Line": {
:
},
"Point": [
:
]
}
]
}
}
}