地点生成

経路探索に利用する地点データを生成します。

GET /v1/{format}/toolbox/course/point

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー 。必須
name string 地点 の名称 。必須
Example:自宅
stationCode int 駅コード複数指定可(最大5件)。stationと排他
station string 駅コードまたは駅の名称。stationCodeと排他。複数指定可(最大5件)
time int 所要時間。複数指定可(最大5件)。必須
単位: 分
fare int 運賃。複数指定可(最大5件)。
単位: 円
traffic string 移動手段。複数指定可(最大5件)。省略可
Example: 徒歩
distance int 距離。複数指定可(最大5件)。省略可
単位: 100m
teiki1 int 1ヶ月定期代。複数指定可(最大5件)。省略可
単位: 円
teiki3 int 3ヶ月定期代。複数指定可(最大5件)。省略可
単位: 円
teiki6 int 6ヶ月定期代。複数指定可(最大5件)。省略可
単位: 円

駅コード等の複数指定について

nameを除くパラメータは複数指定できます。この時、指定順序には意味があり、同じ順番のグループで地点に対するひとつの駅の情報を表します。

以下のリクエスト例は、地点Aが代々木駅(23043)まで徒歩5分の地点データを生成する場合です。

GET /v1/xml/toolbox/course/point?key=アクセスキーを入力してください&name=A&stationCode=23043&time=5&traffic=徒歩

以下のリクエスト例は、上記のA地点に、新宿駅(22741)までタクシーで10分700円の情報を追加した地点データを生成する場合です。1つ目の順番の条件では料金の指定が存在しないため、fareパラメータの値は:700となっています。

GET /v1/xml/toolbox/course/point?key=アクセスキーを入力してください&name=A&stationCode=23043:22741&time=5:10&fare=:700&traffic=徒歩:タクシー

response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / Point 地点 を表す要素
ResultSet / Point / SerializeData 地点データ

example

GET /v1/xml/toolbox/course/point?key=アクセスキーを入力してください&name=ランドマーク名&stationCode=20001&time=5&fare=400&traffic=徒歩
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Point>
    <SerializeData>P-%E3%83%A9%E3%83%B3%E3%83%89%E3%83%9E%E3%83%BC%E3%82%AF%E5%90%8D-20001-5-400-%E5%BE%92%E6%AD%A9--0----</SerializeData>
  </Point>
</ResultSet>
GET /v1/json/toolbox/course/point?key=アクセスキーを入力してください&name=ランドマーク名&stationCode=20001&time=5&fare=400&traffic=徒歩
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Point": {
      "SerializeData": "P-%E3%83%A9%E3%83%B3%E3%83%89%E3%83%9E%E3%83%BC%E3%82%AF%E5%90%8D-20001-5-400-%E5%BE%92%E6%AD%A9--0----"
    }
  }
}