YOLP(地図)
2点間距離API
Version 1
リクエストURL
XML
http://distance.search.olp.yahooapis.jp/OpenLocalPlatform/V1/distance
JSONP
http://distance.search.olp.yahooapis.jp/OpenLocalPlatform/V1/distance
リクエストパラメーター一覧
「RESTリクエストの構築(GET)」をご参照ください。
| パラメーター | 値 | 説明 |
|---|---|---|
| appid (必須) |
string | アプリケーションIDです。詳細はこちらをご覧ください。 |
| coordinates |
string | 緯度経度(経度・緯度をコンマ区切りで指定、スペースで複数点指定)です。 世界測地系で指定してください。 |
| output | string xml(デフォルト), json |
出力形式:
|
| callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメーターです。UTF-8でエンコードした文字列を入力します。 |
API使用上の注意
URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
coordinatesを必ず指定してください。
測地系は世界測地系のみサポートします。
緯度経度は、以下のように必ず「経度」「緯度」の順番で指定してください。
サンプルリクエストURL
緯度経度(3点)を指定した場合
レスポンス
出力形式にXMLを指定(output=xml)した場合、XMLを返します。レスポンスフィールドをご参照ください。
レスポンスフィールド
2点間距離APIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
| フィールド | 説明 |
|---|---|
| YDF | クエリーレスポンスのすべてを含みます。 |
| ResultInfo | レスポンスのまとめ情報です。 |
| Count | レスポンス情報に含まれる住所情報のデータ件数です。 |
| Total | 出力されている住所情報以外も含めた全データ件数です。 |
| Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。 |
| Latency | レスポンス情報を生成するのに要した時間です。 |
| Status | リクエスト元に処理結果を伝えるためのコードです。 正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
| Description | APIの説明文です。 |
| Copyright | コピーライトです。 |
| Feature | 検索結果1件分のデータ群です。 |
| Geometry | 拠点の場所を表すGeometry要素です(世界測地系)。 |
| Type | 図形種別です。 |
| Coordinates | 座標情報です。 |
| Compress | 圧縮された緯度経度列です。 |
| CompressType | 緯度経度の圧縮形式です。 |
| Geodesic | 測地線かどうかを表します。 |
| Distance | 2点間の距離です(Kmで小数点第6位まで)。 |
エラー
| コード | 説明 |
|---|---|
| 400 | 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。 |
| 503 | 内部的な問題によってデータを返すことができない場合に返されます。 |