下記の検索が利用できます。
※)search.jsが必要です。
実装例
検索のメソッドは全て引数にqueryとfuncが必要です。
| 引数 | タイプ | 説明 |
| query | object | 検索に必要なクエリーオブジェクト。検索によって異なる |
| func | function | 検索終了後に実行するコールバックメソッド |
戻り値の第一引数には検索のステータスオブジェクト、第二引数には結果オブジェクトが入ります。
ステータスオブジェクトは全ての検索のメソッドで共通です。
| プロパティ | タイプ | 説明 |
| code | string |
検索が成功した場合には'000'。失敗した場合は下記のコード 100:パラメータエラーなど 101:内部エラー 102:その他のエラー |
| text | string |
検索が成功した場合には'ok'。 失敗した場合はその旨のメッセージ |
デフォルトのタイムアウトは15秒です。
なお、検索はHTTPのGETで行われるためブラウザのURL文字列長制限(IEの2083文字
http://support.microsoft.com/?id=208427)を受けます。
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlons | array(ZDC.LatLon) | - | 地点の緯度経度を配列で指定。上限は100地点 |
| datum | string | TOKYO | 入出力緯度経度の測地系を指定 |
結果オブジェクト
※結果オブジェクトは配列で返却されます
| プロパティ | タイプ | 説明 |
| address | 住所オブジェクト | 住所オブジェクト |
| zipcode | string | 郵便番号 |
| around | boolean | trueの場合、周辺の住所(指定地点が海上などの場合周辺の住所)を取得したことを意味する |
例)
[{"address":{"text":"東京都千代田区丸の内1丁目9-1",
"code":"131010550010000900001",
"latlon":{"lat":35.679777777778,
"lon":139.77165},
"parts":["東京都","千代田区","丸の内","1丁目","9","1"],
"kana":"トウキヨウトチヨダクマルノウチ",
"end":null},
"zipcode":"100-0005",
"around":false}]
住所名称で住所を検索します。
※)ZDC.Search.getAddrByWordV2()はZDC.Search.getAddrByWord()と検索結果が異なることがあります。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| word | string | - |
必須項目。検索語句を指定。検索語句は正規化される ・ZDC.Search.getAddrByWordV2 読み仮名での検索やand条件の複数指定が可能 複数指定する場合は半角スペースまたはカンマ区切り 複数指定の上限は50件で1語句の上限は1024文字 リクエストパラメータaddrcodeを指定せずに、下記条件に該当する値を指定している場合は 検索を行わず検索結果0件を返す 数値1~2桁のみ(例:1、11) 英字1文字のみ(例:a、c) 字丁目以下のみ(例:1-1、1丁目3) ・ZDC.Search.getAddrByWord 上限は1024文字。複数語句、読み仮名での検索はできない。Ver 1.11と同じ検索結果 ※検索結果の違いは例を参照 |
| datum | string | TOKYO | 返却されるPOIの代表点の緯度経度の測地系 |
| limit | string | 0,100 |
検索結果取得件数。"取得開始位置,取得件数"で指定。 取得件数の上限は1000件。1001件以上の指定をした場合は1000件指定と同様の結果。 |
| addrcode | string | - |
検索範囲を指定の住所コードに限定する。例えば13を指定した場合東京都内で検索する ・ZDC.Search.getAddrByWordV2 複数指定はできない ・ZDC.Search.getAddrByWord カンマ区切りで複数指定が可能。上限は50件 |
※正規化ルールはZDC.Search.getAddrByWordV2とZDC.Search.getAddrByWordで違います。
詳細は住所検索時の入力パラメータ(フリーワード)正規化仕様を参照して下さい。
検索結果例
| 例 | 検索文字列 | ZDC.Search.getAddrByWordV2 | ZDC.Search.getAddrByWord |
|
検索する住所の一部が 間違っている場合 |
東京都千代田区丸の内9999 | 0件 | "東京都千代田区丸の内"のみ1件 |
| 読み仮名で検索する場合 | マルノウチ | "東京都千代田区丸の内"など30件 | 0件 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | オブジェクト | 検索条件に一致した件数が"hit"というプロパティで取得できる |
| item | array(住所オブジェクト) | 住所の配列。検索結果が0件の場合は空の配列 |
例)
{"info":{"hit":3},
"item":[{"text":"東京都港区新橋",
"code":"13103016",
"latlon":{"lat":35.663211111111,
"lon":139.75929722222},
"parts":["東京都","港区","新橋"],
"kana":"トウキヨウトミナトクシンバシ",
"end":false,
"level":"oaz"},
:
{"text":"東京都港区東新橋",
"code":"13103023",
"latlon":{"lat":35.658358333333,
"lon":139.75991388889},
"parts":["東京都","港区","東新橋"],
"kana":"トウキヨウトミナトクヒガシシンバシ",
"end":false,
"level":"oaz"}]}
郵便番号で住所を取得します。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| zipcode | string | - | 7桁の郵便番号。ハイフンの有無は問わない |
| datum | string | TOKYO | 返却される住所の代表点の緯度経度測地系 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | オブジェクト | 検索条件に一致した件数が"hit"というプロパティで取得できる |
| item | array(住所オブジェクト) | 住所オブジェクトの配列。検索結果が0件の場合は空の配列 |
例)
{"info":{"hit":1},
"item":[{"text":"東京都港区東新橋1丁目9-1",
"code":"131030230010000900001",
"latlon":{"lat":35.659922222222,
"lon":139.76443611111},
"parts":["東京都","港区","東新橋","1丁目","9","1"],
"kana":"トウキヨウトミナトクヒガシシンバシ",
"end":null}]}
住所コードで住所リストを検索します。
addrcodeに指定した住所の1つ下位の階層に属する住所がない場合、検索結果は0件となります。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| addrcode | string | 都道府県のリストを取得 | 住所コード。指定がない場合、都道府県のリストを取得 |
| datum | string | TOKYO | 返却される住所の代表点の緯度経度の測地系 |
| limit | string | 0,100 |
検索結果取得件数。"取得開始位置,取得件数"で指定。 取得件数の上限は1000件。1001件以上の指定をした場合は1000件指定と同様の結果。 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"というプロパティで取得できる |
| item | array(住所オブジェクト) | 住所オブジェクトの配列。検索結果が0件の場合は空の配列 |
例)
{"info":{"hit":6},
"item":[{"text":"東京都港区新橋1丁目",
"code":"13103016001",
"latlon":{"lat":35.665008333333,
"lon":139.76125833333},
"parts":["東京都","港区","新橋","1丁目"],
"kana":"トウキヨウトミナトクシンバシ",
"end":false},
:
{"text":"東京都港区新橋6丁目",
"code":"13103016006",
"latlon":{"lat":35.658852777778,
"lon":139.756725},
"parts":["東京都","港区","新橋","6丁目"],
"kana":"トウキヨウトミナトクシンバシ",
"end":false}]}
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| address | string | - |
住所文字列を指定。複数指定する場合はカンマ区切り。上限は1000件 (前方一致の検索となる。ただし、都道府県の省略は可能。) |
| datum | string | TOKYO | 入出力緯度経度の測地系を指定 |
| level | string | - | マッチングさせる住所階層 |
※addressの正規化ルールは住所検索時の入力パラメータ(フリーワード)正規化仕様を参照して下さい。
結果オブジェクト
| タイプ | 説明 |
| array(住所オブジェクト) | 住所オブジェクトの配列 |
例)
[{"text":"東京都港区東新橋1丁目6-1",
"code":"131030230010000600001",
"latlon":{"lat":35.661163888889,
"lon":139.76317777778},
"parts":["東京都","港区","東新橋","1丁目","6","1"],
"kana":"トウキヨウトミナトクヒガシシンバシ",
"end":true},
null, //マッチしなかった場合は null
{"text":"東京都港区東新橋2丁目6",
"code":"1310302300200006",
"latlon":{"lat":35.658725,
"lon":139.76022222222},
"parts":["東京都","港区","東新橋","2丁目","6"],
"kana":"トウキヨウトミナトクヒガシシンバシ",
"end":false}]
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlon | ZDC.LatLon | - | 必須項目。緯度経度 |
| radius | number | 500 | 検索範囲の半径をメートルで指定。範囲は0~10000 |
| datum | string | TOKYO | 入出力緯度経度の測地系 |
| word | string | - | 施設名称での絞り込み。上限は1024文字 |
| genrecode | string | - |
絞込みジャンルコード。複数指定する場合はカンマ区切り 検索範囲を指定のジャンルコードに限定5桁または10桁のコードで指定 複数指定かつ10桁で指定する場合上位5桁を同じコードにする必要がある |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"、ジャンルオブジェクトが"facet"というプロパティで取得できる |
| item | array(object) | POIオブジェクトが"poi"、検索地点とPOI代表点との距離(メートル単位)が"distance"で取得できる |
例)
{"info":{"hit":3,
"facet":{"genre":{"0014000180":{"text":"買い物/コンビニ",
"count":3}}}},
"item":[{"poi":{"text":"ローソン新橋1丁目店",
"code":"00000000000000183526",
"latlon":{"lat":35.66485,
"lon":139.76050555556},
"kana":"ローソンシンバシイッチョウメテン",
"addressText":"東京都港区新橋1丁目15-7",
"zipcode":"105-0004",
"phoneNumber":"03-3502-8988",
"genre":{"code":"0014000180",
"text":"買い物/コンビニ"}},
"distance":177},
:
{"poi":{"text":"ローソン東新橋一丁目店",
"code":"00000000000000186998",
"latlon":{"lat":35.661158333333,
"lon":139.76214444444},
"kana":"ローソンヒガシシンバシイッチョウメテン",
"addressText":"東京都港区東新橋1丁目3-1",
"zipcode":"105-0021",
"phoneNumber":"03-3573-7228",
"genre":{"code":"0014000180",
"text":"買い物/コンビニ"}},
"distance":247}]}
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| word | string | - | 必須項目。検索語句を指定。上限1024文字。 |
| datum | string | TOKYO | 返却されるPOIの代表点の緯度経度の測地系 |
| addrcode | string | - |
検索範囲を指定の住所コードに限定。複数指定する場合はカンマ区切り 複数指定かつ5桁で指定する場合は上位2桁を同じコードにする必要がある |
| genrecode | string | - |
絞込みジャンルコード。複数指定する場合はカンマ区切り 検索範囲を指定のジャンルコードに限定5桁または10桁のコードで指定 複数指定かつ10桁で指定する場合上位5桁を同じコードにする必要がある |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"、その他件数情報が"facet"というプロパティで取得できる |
| item | array(POIオブジェクト) | POIオブジェクトの配列を取得できる |
| プロパティ | タイプ | 説明 |
| tod | number | 都道府県コード毎の件数 |
| shk | number | 市町村コード毎の件数 |
| genre | ジャンルオブジェクト |
例)
{"info":{"hit":2,
"facet":{"tod":{"13":2},
"shk":{"13107":1,
"13210":1},
"genre":{"0022000120":{"text":"文化施設/博物館",
"count":2}}}},
"item":[{"text":"東京都江戸東京博物館分館・江戸東京たてもの園",
"code":"00000000000000160822",
"latlon":{"lat":35.712652777778,
"lon":139.51613055556},
"kana":"トウキョウトエドトウキョウハクブツカンブンカンエドトウキョウタ テモノエン",
"addressText":"東京都小金井市桜町3丁目7-1",
"zipcode":"184-0005",
"phoneNumber":"042-388-3300",
"genre":{"code":"0022000120",
"text":"文化施設/博物館"}},
{"text":"東京都江戸東京博物館",
"code":"00000000000000160368",
"latlon":{"lat":35.693319444444,
"lon":139.79917777778},
"kana":"トウキョウトエドトウキョウハクブツカン",
"addressText":"東京都墨田区横網1丁目4-1",
"zipcode":"130-0015",
"phoneNumber":"03-3626-9974",
"genre":{"code":"0022000120",
"text":"文化施設/博物館"}}]}
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| addrcode | string | - | 検索する地域を住所コードで指定。都道府県(2桁)または市区町村(5桁)で指定 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"、住所が"addressText"で取得できる |
| item | array(object) |
路線のコードが"code"、路線名が"text"で取得できる。 注)それぞれラインオブジェクトで取得できる値と一致しない |
例)
{"info":{"hit":15,
"addressText":"東京都台東区"},
"item":[{"code":"28",
"text":"JR京浜東北線"},
:
{"code":"448",
"text":"東武伊勢崎線"}]}
文字列で路線を検索します。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| word | string | - | 検索語句。上限1024文字 |
| addrcode | string | - |
検索範囲を指定の住所コードに限定。複数指定する場合はカンマ区切り 市区町村までのコード(2桁または5桁)を指定できる。 市区町村を複数指定する場合は同一都道府県に限定される |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"というプロパティで取得できる |
| item | array(ラインオブジェクト) | 路線コードを"code"、路線名称を"text"で取得できる |
例)
{
"info":{
"hit":1
},
"item":[
{
"code":"0052",
"text":"JR 東北本線"
},
:
]
}
自動車のルートを探索します。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| from | ZDC.LatLon | - | 出発地点の緯度経度 |
| to | ZDC.LatLon | - | 到着地点の緯度経度 |
| datum | string | TOKYO | 入出力緯度経度の測地系 |
| mpoints | array(ZDC.LatLon) | - | 経由地点の緯度経度。複数点指定できる。上限は20地点 |
| toll | boolean | true | trueの場合有料道路を探索対象とする |
| searchtype | string | time |
検索タイプを指定。 dist:距離を優先して検索を行う time:時間を優先して検索を行う |
| straight | boolean | false | trueの場合右左折回数が少なくなるように探索する |
| cartype | string | normal |
通行料金算出に使用される車種を指定。 light:軽自動車 normal普通車 middle:中型車 large:大型車 big:特大車 |
| smartic | boolean | false | trueの場合スマートICを利用する |
| zoom | number |
指定されたマップタイプに おける縮尺レベルの最大値 |
ルート点列を間引く縮尺レベル。大きいほど精細なルートを描画 |
| mapType | string | - | マップタイプ。ルート点列を間引く場合は必須 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| toll | number | トータルの通行料金。有料道路を全く通過しない場合にはnull |
| time | number | トータルの走行時間(分単位)。走行時間が不明な場合はnull |
| distance | number | トータルの距離(メートル単位) |
| link | array(object) | リンク情報。詳細は下記リンク情報オブジェクト参照 |
| プロパティ | タイプ | 説明 |
| roadType | string | 道路種別 |
| tollFlag | boolean | 有料道路に該当するか否か |
| distance | number | 距離(メートル単位) |
| time | number | 走行時間(秒単位)。走行時間が不明な場合はnull |
| toll | number | 通行利用料金。通行料金算出不能な場合はnull |
| line | array(ZDC.LatLon) | 緯度経度の配列 |
| guidance | object |
誘導情報。誘導情報が存在しない場合はnull。現在は地点型誘導情報のみ対応している。 詳細はガイダンス情報オブジェクト参照 |
| guidanceHighway | object |
地点名情報。地点名情報が存在しない場合はnull。 詳細はガイダンスハイウェイ情報オブジェクト参照 |
| プロパティ | タイプ | 説明 |
| crossName | string | 交差点名称。データが存在しない場合はnull |
| roadName | string | 道路名称。データが存在しない場合はnull |
| guideType | string | 誘導区分(交差点拡大図/ハイウェイモード/直進交差点案内/画像誘導) |
| angle | number |
進入道路に対する脱出道路の方向(角度)を記述する。 方向は進入道路の直進方向を0度とし、右回りに0~359度の値をとる。データが存在しない場合はnull |
| straightFlag | boolean | trueの場合進入道路に対する脱出道路が道なりを表す。データが存在しない場合はnull |
| crossImageUri | string | 交差点画像(JCT画像/3D交差点画像)。データが存在しない場合はnull |
| signboardImageUri | string | 方面看板画像。データが存在しない場合はnull |
| etcImageUri | string | ETCレーン誘導画像。データが存在しない場合はnull |
| プロパティ | タイプ | 説明 |
| pointType | object |
地点種別オブジェクト。以下のプロパティを持つ。それぞれの値はbooleanです。 ic : 地点がICの場合 true sa : 地点がサービスエリアの場合 true pa : 地点がパーキングエリアの場合 true jct : 地点がジャンクションの場合 true 複数 true となる場合があります(ic と jct等)。すべて falseとなる場合があります(料金所等)。 |
| pointName | string | 地点名称。データが存在しない場合はnull |
例)
{"route":{"toll":120,
"time":76,
"distance":60128,
"link":[{"roadType":"道路外",
"tollFlag":false,
"distance":14,
"time":0,
"toll":0,
"line":[{"lat":35.672382777778,"lon":139.77129083333},
{"lat":35.672516111111,"lon":139.77134638889}],
"guidance":null},
{"roadType":"国道",
"tollFlag":false,
"distance":22,
"time":5,
"toll":0,
"line":[{"lat":35.684316944444,"lon":139.34589861111},
{"lat":35.684494722222,"lon":139.34602083333}],
"guidance":{"crossName":"左入橋",
"roadName":"国道16号線",
"guideType":"交差点拡大図",
"angle":4,
"straightFlag":false,
"crossImageUri":null,
"signboardImageUri":"http://apicore/core/v1_0/cache/c2d0cd2e497f2f969c45e041fdba5caa.png",
"etcImageUri":null},
"guidanceHighway":{"pointType":{"ic":false,
"sa":false,
"pa":false,
"jct":false},
"pointName":"加賀料金所(上り入口)"}
}]
}
}
| 道路種別 |
| 高速道路 |
| 都市高速道路 |
| 国道 |
| 主要地方道 |
| 都道府県道 |
| 一般道路(幹線) |
| 一般道路(その他) |
| 導入路 |
| 細街路(主要) |
| 細街路(詳細) |
| フェリー航路 |
| 道路外 |
歩行者のルートを探索します。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| from | ZDC.LatLon | - | 出発地点の緯度経度 |
| to | ZDC.LatLon | - | 到着地点の緯度経度 |
| datum | string | TOKYO | 入出力緯度経度の測地系 |
| mpoints | array(ZDC.LatLon) | - |
経由地点の緯度経度を指定。複数点指定できる。上限は20点。 (経由地点の指定は無し。常に立ち寄り地点とする) |
| searchtype | string | time |
検索タイプを指定。 dist:距離を優先する time:時間を優先する easy:楽な道を優先する roof:屋根がある道を優先する highway:幹線道路を優先する |
| maxdist | number | 5 |
検索距離の上限を指定。 5:5キロメートル 10:10キロメートル |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| distance | number | トータルの距離(メートル単位) |
| link | array(object) | リンク情報。詳細は下記リンク情報オブジェクト参照 |
| プロパティ | タイプ | 説明 |
| type | string | 通路種別 |
| structureType | string | 構造種別 |
| roof | boolean | trueの場合は屋根がある |
| distance | number | 距離(メートル単位) |
| line | array(ZDC.LatLon) | 緯度経度の配列 |
例)
{"route":{"distance":499,
"link":[{"type":"通路外",
"structureType":"通常",
"roof":false,
"distance":5,
"line":[{"lat":35.664,"lon":139.756},
{"lat":35.664022222222,"lon":139.75595}],
{"type":"通常通路",
"structureType":"通常",
"roof":false,
"distance":30,
"line":[{"lat":35.664024722222,"lon":139.75595083333},
{"lat":35.663896944444,"lon":139.75588416667},
{"lat":{35.663763611111,"lon":139.7558175}]
}
]
}
}
| 通路種別 |
| 通常通路 |
| 横断歩道 |
| 横断通路 |
| 歩道橋 |
| 踏切内通路 |
| 連絡通路 |
| 建物内通路 |
| 敷地内通路 |
| 乗換リンク |
| 通路外 |
| 構造種別 |
| 通常 |
| 階段 |
| エスカレーター |
| エレベーター |
| スロープ |
| 動く歩道 |
| 段差 |
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlon | ZDC.LatLon | 緯度経度 | |
| radius | number | 500 | 検索範囲の半径をメートルで指定。0~10000 |
| datum | string | TOKYO | 返却されるPOIの代表点の緯度経度測地系 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"で取得できる |
| item | array(object) | POIオブジェクトが"poi"、ラインオブジェクトが"line"、検索地点とPOI代表点との距離(メートル単位)が"distance"で取得できる |
例)
{"info":{"hit":4},
"item":[{"poi":{"text":"日本橋駅(東京メトロ 銀座線)",
"code":"00000000000000203820",
"latlon":{"lat":35.678672222222,
"lon":139.77654722222},
"kana":"ニホンバシエキ",
"addressText":"東京都中央区日本橋1丁目3-11",
"zipcode":"103-0027",
"phoneNumber":"03-3271-2768",
"genre":null},
"line":{"code":"0508",
"text":"東京地下鉄 3号銀座線"},
"distance":133},
:
{"poi":{"text":"三越前駅(東京メトロ 半蔵門線)",
"code":"00000000000000204151",
"latlon":{"lat":35.68165,
"lon":139.77639444444},
"kana":"ミツコシマエエキ",
"addressText":"東京都中央区日本橋室町1丁目2",
"zipcode":"103-0022",
"phoneNumber":"03-3279-3164",
"genre":null},
"line":{"code":"0510",
"text":"東京地下鉄 11号半蔵門線"},
"distance":452}]}
ポリライン沿いのPOIを検索します。
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlons | array(ZDC.LatLon) | - | 2点以上の緯度経度からなるポリライン |
| word | string | - |
施設名称での絞り込み。上限は1024文字 複数指定する場合はカンマもしくはセミコロン区切り |
| srchtype | string | and |
施設名称を複数指定した場合の検索タイプ and:全てANDで検索を行う or:全てORで検索を行う |
| buffer | number | 20 | 指定のポリラインからの検索対象範囲をメートルで指定。範囲は0~200 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
| datum | string | TOKYO | 入出力緯度経度の測地系を指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"というプロパティで取得できる |
| item | array(object) |
POIオブジェクトが"poi"、POIの位置は"side"で取得できる。 "side"の値は、POIの位置がポリラインに対して右側の場合はright、左側の場合はleftとなる。 ポリラインの方向は、latlonsの配列順である |
例)
{
"info":{
"hit":1
},
"item":[
{
"poi":{
"text":"ローソン銀座三丁目店",
"code":"1561370",
"latlon":{
"lat":35.672075,
"lon":139.7678331
},
"kana":"ロ-ソンギンザサンチョウメテン",
"addressText":"東京都中央区銀座3丁目8-1",
"zipcode":"104-0061",
"phoneNumber":"03-3563-3731",
"genre":null
},
"side":"right"
},
:
]
}
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| genrecode | string | - |
必須項目。検索範囲を指定のジャンルコードに限定。 複数指定する場合はカンマ区切り 5桁または10桁のコードで指定、複数指定かつ10桁で指定する場合上位5桁を同じコードにする必要がある |
| word | string | - | 施設名称での絞り込み。上限は1024文字 |
| addrcode | string | - |
検索範囲を指定の住所コードに限定。複数指定する場合はカンマ区切り 複数指定かつ5桁で指定する場合は上位2桁を同じコードにする必要がある |
| srchtype | string | and |
施設名称を複数指定した場合の検索タイプ。 and:全てANDで検索を行う or:全てORで検索を行う |
| datum | string | TOKYO | 返却されるPOIの代表点の緯度経度の測地系 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"、その他件数情報が"facet"というプロパティで取得できる |
| item | array(POIオブジェクト) | POIオブジェクトの配列を取得できる |
| プロパティ | タイプ | 説明 |
| tod | number | 都道府県コード毎の件数 |
| shk | number | 市町村コード毎の件数 |
| genre | ジャンルオブジェクト |
例)
{
"info":{
"hit":29,
"facet":{
"tod":{
"13":29
},
"shk":{
"13106":29
},
"genre":{
"0014000240":{
"text":"買い物/本屋",
"count":27
},
"0014000250":{
"text":"買い物/ビデオ・CD",
"count":2
}
}
}
},
"item":[
{
"text":"(株)亜東書店",
"code":"00000000000002526943",
"latlon":{
"lat":35.707108333333,
"lon":139.78035277778
},
"kana":"アトウショテン",
"addressText":"東京都台東区東上野2丁目18-7",
"zipcode":"110-0015",
"phoneNumber":"03-3835-7091",
"genre":{
"code":"0014000240",
"text":"買い物/本屋"
}
},
:
]
}
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlons | array(ZDC.LatLon) | - | 緯度経度(上限は300点) |
| meshType | string | N05m,N10m,D50m |
検索する精度を指定。複数指定する場合はカンマ区切り 複数指定した場合、N05m,N10m,D50mの順で検索し最初に取得できた値が返却される N05m : 5平方メートルの精度の標高データ N10m : 10平方メートルの精度の標高データ D50m : 50平方メートルの精度の水深データ |
結果オブジェクト
| タイプ | 説明 |
| array(標高オブジェクト) | 標高オブジェクトの配列 |
緯度経度の点列から移動した経路を推定し、道路リンクデータを返却します。
GPS点列などの補正に利用できます。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlons | array(ZDC.LatLon) | - | 緯度経度(上限は50点) |
| code | string | - |
リンクコード。前回のリクエスト結果に繋げる場合は、前回の結果オブジェクトに含まれる lastプロパティのcodeを指定する。指定がない場合、latlonsで指定した最初の点に一番近い リンクを取得する |
| order | string | - |
接続情報。前回のリクエスト結果に繋げる場合は、前回の結果オブジェクトに含まれる lastプロパティのorderを指定する |
| datum | string | TOKYO | 入出力緯度経度の測地系を指定 |
| nearlimit | number | 300 | code の指定がない場合に、検索範囲をメートルで指定。範囲は0~500 |
| edgeadjust | string | neither |
調整コードを指定。latlonsの一点目と最初のリンクの距離が最小になるリンク上の点を始点 にする。latlonsの最後の点と最終リンクの距離が最小になるリンク上の点を終点にする。 返却されるリンクデータ数が1つの場合、本パラメータは無効になる。 neither:始点、終点ともに調整しない start:始点のみ調整する。code が指定されている場合は無効になる end:終点のみ調整する both:始点、終点ともに調整する。code が指定されている場合は始点調整は無効になる 使用例は下記のedgeadjustの使用例で示す |
| roundpath | boolean | false | 往復路となっているリンク部分を削除する |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| last | object | 道路リンク最後のリンクコードを"code"、道路リンク最後の接続情報を"order"で取得できる |
| item | array(object) |
前回のリクエスト結果と接続しているかどうかの真偽値が"connection"、道路リンクオブジェクトが"roadLink" というプロパティで取得できる |
| プロパティ | タイプ | 説明 |
| code | string | リンクコード |
| distance | number | リンク距離(メートル) |
| latlons | array(ZDC.LatLon) | 緯度経度の配列 |
| roadType | object | 道路種別。種別コードを"code"、種別名称を"text"で取得できる |
例)
{
"last":{
"code":"7417648",
"order":"OE"
},
"item":[
{
"roadLink":{
"code":"7417647",
"distance":48,
"latlons":[
{
"lat":35.6658528,
"lon":139.7538528
},
{
"lat":35.6656189,
"lon":139.7537383
}
],
"roadType":{
"code":"6",
"text":"一般道路(その他)"
}
},
"connection":false
},
:
]
}
| 種別コード | 種別名称 |
| 0 | 高速道路 |
| 1 | 都市高速道路 |
| 2 | 国道 |
| 3 | 主要地方道 |
| 4 | 都道府県道 |
| 5 | 一般道路(幹線) |
| 6 | 一般道路(その他) |
| 7 | 導入路 |
| 8 | 細道路(幹線) |
| 9 | 細道路(その他) |
| 10 | フェリー航路 |
| 15 | 道路外 |
注)こちらの道路種別と自動車ルート検索の道路種別は別物である。
駅名称での駅情報の検索をおこないます。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| word | string | - | 検索語句。上限1024文字。複数語句での検索はできない |
| datum | string | TOKYO | 返却されるPOIの代表点の緯度経度測地系 |
| addrcode | string | - |
検索範囲を指定の住所コードに限定。複数指定する場合はカンマ区切り 市区町村までのコード(2桁または5桁)を指定できる。 市区町村を複数指定する場合は同一都道府県に限定される |
| sort | string | -score |
出力順を指定。デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付加する score:マッチングスコア nm:施設名称 kn:施設名カナ tod:都道府県コード line:路線コード fnm:完全一致 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"で取得できる |
| item | array(object) | POIオブジェクトが"poi"、ラインオブジェクトが"line"で取得できる |
例)
{"info":{"hit":8,
"facet":{"tod":{"13":5,
"27":3},
"shk":{"13102":5,
"27128":3}}},
"item":[{"poi":{"text":"近鉄日本橋駅(近鉄 難波線)",
"code":"00000000000000389709",
"latlon":{"lat":34.663691666667,
"lon":135.50862777778},
"kana":"キンテツニッポンバシエキ",
"addressText":"大阪府大阪市中央区日本橋1丁目5-12",
"zipcode":"542-0073",
"phoneNumber":"06-6213-2390",
"genre":null},
"line":{"code":"0276",
"text":"近畿日本鉄道 難波線"}},
:
{"poi":{"text":"日本橋駅(東京メトロ 東西線)",
"code":"00000000000000203821",
"latlon":{"lat":35.678672222222,
"lon":139.77654722222},
"kana":"ニホンバシエキ",
"addressText":"東京都中央区日本橋1丁目3-11",
"zipcode":"103-0027",
"phoneNumber":"03-3271-2768",
"genre":null},
"line":{"code":"0506",
"text":"東京地下鉄 5号東西線"}}]}
路線コードでの駅情報の検索をおこないます。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| linecode | string | - | 路線コード。複数コードでの検索はできない |
| word | string | - | 駅名称での絞込み(カナ指定可)。上限1024文字。複数語句の指定はできない |
| addrcode | string | - |
検索範囲を指定の住所コードに限定。複数指定する場合はカンマ区切り 市区町村までのコード(2桁または5桁)を指定できる。 市区町村を複数指定する場合は同一都道府県に限定される |
| datum | string | TOKYO | 返却されるPOIの代表点の緯度経度測地系 |
| limit | string | 0,100 | 検索結果取得件数。"取得開始位置,取得件数"で指定 |
結果オブジェクト
| プロパティ | タイプ | 説明 |
| info | object | 検索条件に一致した件数が"hit"で取得できる |
| item | array(object) | POIオブジェクトが"poi"、ラインオブジェクトが"line"で取得できる |
例)
{
"info": {
"hit": 1
},
"item": [
{
"poi": {
"text": "都立大学駅(東急 東横線)",
"code": "20000000000000003352",
"latlon": {
"lat": 35.6145917,
"lon": 139.6796167
},
"kana": "トリツダイガクエキ",
"addressText": "東京都目黒区中根4丁目",
"zipcode": "152-0031",
"phoneNumber": null,
"genre": null
},
"line": {
"code": "0499",
"text": "東京急行電鉄 東横線"
}
}
]
}
緯度経度の測地系を高精度変換します。
高精度変換できない地点は で変換した緯度経度を返します。
※ 精度を求めない場合はZDC.tkyTowgs/ZDC.wgsTotky(課金対象外)をご利用ください。
動作確認
クエリーオブジェクト
| プロパティ | タイプ | デフォルト | 説明 |
| latlons | array(ZDC.LatLon) | - | 地点の緯度経度を配列で指定。上限は200点 |
| mode | string | tkywgs |
測地系の変換パターンを指定。 tkywgs:日本測地系から世界測地系に変換 wgstky:世界測地系から日本測地系に変換 |
結果オブジェクト
| タイプ | 説明 |
| array(ZDC.LatLon) | ZDC.LatLonオブジェクトの配列 |
例)
[
{"lat":35.6902403,
"lon":139.7529608},
{"lat":35.6901333,
"lon":139.7527208},
{"lat":35.6900364,
"lon":139.7524806}
]
検索の実行時に取得し、検索を中止するabort()メソッドを実行できます。
このメソッドの戻り値はステータスオブジェクト
です。
実行例)
var obj = ZDC.Search.getAddrByWord({…}, function() {…});
obj.abort();
| プロパティ | タイプ | 説明 |
| text | string | POIの名称 |
| code | string | POIのコード |
| latlon | ZDC.LatLon | 代表点の緯度経度 |
| kana | string | 住所文字列のカナ表記 |
| addressText | string | 住所文字列 |
| zipcode | string | 郵便番号 |
| phoneNumber | string | 電話番号 |
| genre | ジャンルオブジェクト | ジャンルオブジェクト |
| detail | 詳細図オブジェクト | 詳細図情報がない場合はNULL |
| arrivalInfo | array(到着地点オブジェクト) | 到着地点情報がない場合は空の配列 |
例)
{"text":"ローソン新橋1丁目店",
"code":"00000000000000183526",
"latlon":{"lat":35.66485,
"lon":139.76050555556},
"kana":"ローソンシンバシイッチョウメテン",
"addressText":"東京都港区新橋1丁目15-7",
"zipcode":"105-0004",
"phoneNumber":"03-3502-8988",
"genre":{"code":"0014000180",
"text":"買い物/コンビニ"}
ジャンルコードをプロパティとして下記のオブジェクトを取得できる
例)
{"0022000120":{
"text":"文化施設/博物館",
"count":2},
"0014000180":{
"text":"買い物/コンビニ",
"count":3}}
| プロパティ | タイプ | 説明 |
| areaid | string | エリアID |
| areaname | string | エリア名称 |
| detailid | string | 詳細図シーケンス番号 |
| detailname | string | 詳細図名称 |
| floorname | string | フロア名称 |
| level | string | 階層レベル |
例)
"detail": {
"areaid": "003",
"areaname": "秋葉原・東京・有楽町・銀座・新橋エリア",
"detailid": "00000005",
"detailname": "JR東京駅",
"floorname": "2階",
"level": "1"
}
| プロパティ | タイプ | 説明 |
| text | string | 到着地点名称 |
| kana | string | 到着地点カナ |
| exittype | object |
到着地点出入口種別オブジェクト 種別コードが"code"、種別名称が"text"で取得できる |
| arrivalpoint | ZDC.LatLon | 到着地点緯度経度(自動車到着地点緯度経度) |
| exitpoint | ZDC.LatLon | 出入り口緯度経度 |
例)
"arrivalInfo": [
{
"text": "正面",
"kana": "ショウメン",
"exittype": {
"code": "03",
"text": "出入口"
},
"arrivalpoint": {
"lat": 34.4264361,
"lon": 133.1926
},
"exitpoint": {
"lat": 34.4264806,
"lon": 133.1925333
}
}
]
| プロパティ | タイプ | 説明 |
| code | string | 路線コード |
| text | string | 路線名称 |
注)それぞれZDC.Search.getRailLineByAddrCode()で取得できる値と一致しない
例)
{"code":"0506",
"text":"東京地下鉄 5号東西線"}
| プロパティ | タイプ | 説明 |
| text | string | 住所表記文字列 |
| code | string | 住所コード |
| latlon | ZDC.LatLon | 代表点の緯度経度 |
| parts | array(string) | 住所階層毎に分割された文字列 |
| kana | string | 住所読み仮名 |
| end | boolean or null | 住所にさらに下の階層がある場合はfalse、そうでない場合はtrue。不明の場合はnullとなる |
| kanaParts | string | 住所階層毎に分割されたカナ文字列 |
| level | string | 住所階層 |
例)
{"text":"東京都千代田区丸の内1丁目9-1",
"code":"131010550010000900001",
"latlon":{"lat":35.679777777778,
"lon":139.77165},
"parts":["東京都","千代田区","丸の内","1丁目","9","1"],
"kana":"トウキヨウトチヨダクマルノウチ",
"end":true}
| プロパティ | タイプ | 説明 |
| elevation | number | 標高値(メートル単位)。水深部はマイナスの値が返却される |
| meshType | string | 最初に値が取得できた精度。詳細はクエリーオブジェクトのmeshTypeを参照 |
例)
{"elevation":38.5,
"meshType":"N05m"}