路線図画像
「駅すぱあと」が保持する路線図を取得します。
GET /v1/{format}/railmap/data
parameters
※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。
Name | Type | Required | Description |
---|---|---|---|
format | string | ◯ | レスポンスのデータ形式の指定。必須 指定できる値: - xml: xml形式のデータ - json: json形式のデータ - png: png形式のデータ - bmp: bmp形式のデータ - jpg: jpg形式のデータ ※クエリパラメータではなくパスに値を指定します。 |
key | string | ◯ | アクセスキー。必須 |
id | string | ◯ | 路線図のID。必須 |
x | int | ◯ | 路線図X座標。路線図取得の起点となる路線図座標Xを指定します。必須 |
y | int | ◯ | 路線図Y座標。路線図取得の起点となる路線図座標Yを指定します。必須 |
width | int | ◯ | 横幅指定。横軸起点Xからの幅を指定します。指定可能な値は1〜500です。必須 |
height | int | ◯ | 横幅指定。縦軸起点Yからの幅を指定します。指定可能な値は1〜500です。必須 |
response
Name | Description |
---|---|
ResultSet | レスポンスの最下部を表す要素 |
ResultSet / apiVersion | WebAPIバージョン |
ResultSet / engineVersion | エンジンバージョン |
ResultSet / RailMap | 路線図を表す要素 |
ResultSet / RailMap / height | 路線図の縦幅 |
ResultSet / RailMap / id | 路線図のID |
ResultSet / RailMap / width | 路線図の横幅 |
ResultSet / RailMap / x | 路線図のX座標 |
ResultSet / RailMap / y | 路線図のX座標 |
ResultSet / RailMap / ImageData | 画像を表す要素(Base64) |
ResultSet / RailMap / ImageData / format | 画像フォーマット |
example
GET /v1/xml/railmap/data?key=アクセスキーを入力してください&id=tokyo&x=3000&y=600&width=500&height=500
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201110_02a">
<RailMap id="tokyo" x="3000" y="600" width="500" height="500">
<ImageData format="png">...</ImageData>
</RailMap>
</ResultSet>
GET /v1/json/railmap/data?key=アクセスキーを入力してください&id=tokyo&x=3000&y=600&width=500&height=500
{
"ResultSet": {
"apiVersion": "1.14.0.0",
"engineVersion": "201110_02a",
"RailMap": {
"id": "tokyo",
"x": "3000",
"y": "600",
"width": "500",
"height": "500",
"ImageData": {
"text": "...",
"format": "png"
}
}
}
}
GET /v1/png/railmap/data?key=アクセスキーを入力してください&id=tokyo&x=3000&y=600&width=500&height=500
GET /v1/bmp/railmap/data?key=アクセスキーを入力してください&id=tokyo&x=3000&y=600&width=500&height=500
GET /v1/jpg/railmap/data?key=アクセスキーを入力してください&id=tokyo&x=3000&y=600&width=500&height=500