Route map image
Attention!
This page has not been fully translated into English yet.
It is possible that some parts of description may contains old information.
Please see Japanese Documents if you need the latest and accurate information.
It will acquire the route map held by Ekispert.
GET /v1/{format}/railmap/data
parameters
Name | Type | Description |
---|---|---|
format | string | Specification of the response data format. Required. Possible values: - xml: xml format data - png: png format data - bmp: bmp format data - jpg: jpg format data |
key | string | Your access key. Required. |
id | string | Route map ID. Required |
x | int | Route map X coordinate. Assigns route map X coordinate as starting point from route map. Required. |
y | int | Route map Y coordinate. Assigns route map Y coordinate as starting point from route map. Required. |
width | int | Assign width. Assigns width from horizontal axis starting point X. Assignable values 1-500. Required |
height | int | Assign width. Assigns width from vertical axis starting point Y. Assignable values 1-500. Required |
response
Name | Description |
---|---|
ResultSet | Root element of response |
ResultSet / apiVersion | Web API version |
ResultSet / engineVersion | Engine version |
ResultSet / RailMap | Component showing route map |
ResultSet / RailMap / height | Route map height and width |
ResultSet / RailMap / id | Route map ID |
ResultSet / RailMap / width | Route map width |
ResultSet / RailMap / x | Route map X coordinate |
ResultSet / RailMap / y | Route map X coordinate |
ResultSet / RailMap / ImageData | Component showing image (Base64) |
ResultSet / RailMap / ImageData / format | Image format |
example
GET /v1/xml/railmap/data?key=your_access_key_here&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=your_access_key_here&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=your_access_key_here&id=tokyo&x=3000&y=600&width=500&height=500
GET /v1/bmp/railmap/data?key=your_access_key_here&id=tokyo&x=3000&y=600&width=500&height=500
GET /v1/jpg/railmap/data?key=your_access_key_here&id=tokyo&x=3000&y=600&width=500&height=500