YOLP(地図)

2点間距離API

リクエストURL
XML
http://distance.search.olp.yahooapis.jp/OpenLocalPlatform/V1/distance
JSONP
http://distance.search.olp.yahooapis.jp/OpenLocalPlatform/V1/distance



目次




概要

2点間の緯度経度を指定して、地球の楕円体に合わせた正確な距離(大圏距離)を計算し提供します。




リクエストパラメーター一覧

RESTリクエストの構築(GET)」をご参照ください。

パラメーター説明
appid
(必須)
string アプリケーションIDです。詳細はこちらをご覧ください。
coordinates
string 緯度経度(経度・緯度をコンマ区切りで指定、スペースで複数点指定)です。
世界測地系で指定してください。
output string
xml(デフォルト),
json
出力形式:
  • xml - XML形式
  • json - JSON形式
callback string
JSONPとして出力する際のコールバック関数名を入力するためのパラメーターです。UTF-8でエンコードした文字列を入力します。

API使用上の注意

URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。

coordinatesを必ず指定してください。

測地系は世界測地系のみサポートします。

緯度経度は、以下のように必ず「経度」「緯度」の順番で指定してください。

サンプルリクエストURL

緯度経度(3点)を指定した場合

http://distance.search.olp.yahooapis.jp/OpenLocalPlatform/V1/distance ?coordinates=139.73091159286,35.665662327613 135.49513388889,34.701974166667 130.42052944444,33.589735 &appid=<あなたのアプリケーションID>



レスポンス

出力形式に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位まで)。



サンプルレスポンス

以下は、緯度経度を3点指定した場合のレスポンスです

XML形式

<?xml version="1.0" encoding="UTF-8"?>
<YDF firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1" xmlns="http://olp.yahooapis.jp/ydf/1.0">
  <ResultInfo>
    <Count>1</Count>
    <Total>1</Total>
    <Start>1</Start>
    <Latency>0.0017468929290771</Latency>
    <Status>200</Status>
    <Description>2点間の緯度経度を指定して地球の楕円体に合わせた正確な距離を取得する機能を提供します。</Description>
    <Copyright>Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved.</Copyright>
    <CompressType />
  </ResultInfo>
  <Feature>
    <Geometry>
      <Type>linestring </Type>
      <Coordinates>139.73091159286,35.665662327613 135.49513388889,34.701974166667 130.42052944444,33.589735</Coordinates>
      <Distance>884.249118</Distance>
      <Geodesic>true</Geodesic>
    </Geometry>
  </Feature>
</YDF>

JSON形式

{

    "ResultInfo": {
        "Count": 1,
        "Total": 1,
        "Start": 1,
        "Latency": 0.0019030571,
        "Status": 200,
        "Description": "2点間の緯度経度を指定して地球の楕円体に合わせた正確な距離を取得する機能を提供します。",
        "Copyright": "Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved.",
        "CompressType": ""
    },
    "Feature": [
        {
            "Geometry": {
                "Type": "linestring ",
                "Distance": 884.249118,
                "Geodesic": "true",
                "Coordinates": "139.73091159286,35.665662327613 135.49513388889,34.701974166667 130.42052944444,33.589735"
            }
        }
    ]

}



エラー

コード 説明
400 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。
503 内部的な問題によってデータを返すことができない場合に返されます。

<Error>
  <Message>パラメーターが不正です。</Message>
  <Detail>
    <Code>400</Code>
  </Detail>
</Error>