YOLP（地図）
ルート沿い検索API
Version 1
リクエストURL
XML
http://spatial.search.olp.yahooapis.jp/OpenLocalPlatform/V1/shapeSearch
JSONP
http://spatial.search.olp.yahooapis.jp/OpenLocalPlatform/V1/shapeSearch
リクエストパラメーター一覧
「RESTリクエストの構築（GET）」をご参照ください。
| パラメーター | 値 | 説明 |
|---|---|---|
| appid （必須） |
string | アプリケーションIDです。詳細はこちらをご覧ください。 |
| query |
string | （UTF-8でエンコードされた）検索クエリーです。 |
| coordinates |
string | 緯度経度（経度・緯度をコンマ区切りで指定、スペースで複数点指定）です。 |
| precision |
integer:10（デフォルト） | 検索精度を指定します。1～25まで指定でき、数が大きい方が精度が高くなります。 |
| z |
integer:16 （デフォルト） | 縮尺を指定します。詳細はこちらをご覧ください。 |
| mode |
string auto（デフォルト） line circle |
検索モードです。
|
| sort |
string mix（デフォルト） box |
並べ替え順です。
|
| results | integer: 10（デフォルト） | 取得件数を指定します（最大100）。 |
| output | string xml（デフォルト）, json |
出力形式：
|
| callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメーターです。UTF-8でエンコードした文字列を入力します。 |
API使用上の注意
URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
サンプルリクエストURL
緯度経度による指定
レスポンス
出力形式にXMLを指定（output=xml）した場合、XMLを返します。レスポンスフィールドをご参照ください。
レスポンスフィールド
ルート沿い検索APIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
| フィールド | 説明 |
|---|---|
| YDF | クエリーレスポンスのすべてを含みます。 |
| ResultInfo | レスポンスのまとめ情報です。 |
| Count | レスポンス情報に含まれる住所情報のデータ件数です。 |
| Total | 出力されている住所情報以外も含めた全データ件数です。 |
| Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。 |
| Latency | レスポンス情報を生成するのに要した時間です。 |
| Status | リクエスト元に処理結果を伝えるためのコードです。正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
| Feature | 検索結果1件分のデータ群です。 |
| Id | カセット内部のIDです。 |
| Gid | 拠点ごとに割り当てられた拠点の管理IDです。 |
| Name | 地域・拠点情報名です。 |
| Geometry | 拠点の場所を表すGeometry要素です（世界測地系）。 |
| Type | 図形種別です。 |
| Coordinates | 座標情報です。 |
| Property | 地域・拠点情報の詳細要素です。 |
| Uid | Yahoo! Open Local Platform（YOLP）での識別IDです。 |
| CassetteId | カセットIDです。 |
| Yomi | 地域・拠点情報名の読みです。 |
| Country | 国情報です。 |
| Code | 国コード（ISO 3166-1）です。 |
| Name（Countryの子要素） | 国名です。 |
| Address | 1行で表す住所です。 |
| GovernmentCode | 住所コード（JIS X 0401 5けた）です。 |
| Station | 最寄り駅情報です。 最大3件です。 |
| Id（Stationの子要素） | 駅IDです。 |
| Name（Stationの子要素） | 駅名です。 |
| Railway（Stationの子要素） | 代表路線名です。 |
| Exit（Stationの子要素） | 最寄り駅の出口名です。 |
| ExitviewId （Stationの子要素） | 最寄り駅の出口IDです。 |
| Distance（Stationの子要素） | 最寄り駅の出口からの距離（m）です。 |
| BuildingInfo | 店舗が入るビル情報を格納します。 |
| Id（BuildingInfoの子要素） | ビルIDです。 |
| Name（BuildingInfoの子要素） | ビルの名称です。 |
| Floor（BuildingInfoの子要素） | ビルの階数です。 |
| PlaceInfo | 店舗が入る場所情報を格納します。 |
| FloorName（PlaceInfoの子要素） | フロア名です。 |
| MapType（PlaceInfoの子要素） | 最適な地図の種別です。 |
| MapScale（PlaceInfoの子要素） | この地域・拠点名を表示するのに適切な地図の縮尺です。 |
| Time | 最寄り駅の出口からの徒歩時間です。 |
| Tel1 | 電話番号です。 |
| Genre | 店舗のジャンルです（※複数あり）。 |
| Code（Genreの子要素） | 業種コードです。 |
| Name（Genreの子要素） | ジャンル名です。 |
| CatchCopy | キャッチコピーです。 |
| Coupon | クーポン情報です。 |
| ReviewCount | レビュー数です。 |
| Detail | 詳細情報です。 |
| ZipCode | 郵便番号です。 |
| Fax1 | Fax番号です。 |
| Access1 | アクセス方法です。 |
| Copyright | コピーライトです。 |
| PcUrl1 | パソコンサイトのURLです。 |
| MobileUrl1 | モバイルサイトのURLです。 |
| ReviewUrl1 | レビューのURLです。 |
| Image1 | 画像情報です。 |
| Style | Style情報です。 |
こちらで定義されているレスポンスフィールドはデフォルトのものです。カセットごとに拡張されたレスポンスフィールドを持つ場合があります。YDFの説明やスキーマの記述を参考にしてください。
エラー
| コード | 説明 |
|---|---|
| 400 | 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。 |
| 503 | 内部的な問題によってデータを返すことができない場合に返されます。 |
