フリーワードでの建物検索

API名: 
building/word
概要: 

フリーワードを元に、該当する建物情報を返却します。

※この機能を利用するには別途契約が必要です。

URI: 

http://core.its-mo.com/zmaps/api/apicore/core/v1_0/building/word

<API使用例>
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/building/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=町,新宿&addrcode=11,13,22&limit=1,3

リクエストパラメータ
パラメータ 必須 デフォルト値 説明
word - 検索ワード
検索ワードを指定します。複数指定できます。
複数指定する場合、5件まで指定できます。それ以上の場合はエラーとなります。
半角スペース、全角スペースは取り除かれます。
1ワードの最大文字数は1024文字です。
addrcode   00 絞込み住所コード
住所コードで検索結果を絞り込みます。
都道府県、市区町村(2桁or5桁)まで指定可能です。それ以外の指定はエラーになります。
複数指定可能ですが、以下のパターンの場合はエラーになります。
・都道府県(2桁)と市区町村(5桁)を織り交ぜた場合
・00を含めた複数指定の場合
・市区町村(5桁)の複数指定で、都道府県が異なる場合
limit   0,100 検索結果取得件数
検索結果取得件数を指定します。
指定可能値は、取得開始位置:0~1000、取得件数:1~1000となります。
srchtype   and 検索タイプ
リクエストパラメータwordを複数指定した場合の検索タイプを指定します。
指定値 説明
and AND検索
or OR検索
sort   -score 出力順
出力順を指定します。複数指定可能です。
デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付けます。
以下のキー以外のパラメータはエラーとなります。
指定値 説明
score マッチングスコア(降順)
nm 施設名称
tod 都道府県コード
fnm 完全一致
snm 前方一致
nmlen 名称の文字数
datum   TOKYO 測地系
入出力緯度経度の測地系を指定します。
llunit   dec 緯度経度形式
緯度経度形式を指定します。

出力データ
出力フォーマット
{"status":{"code":"00000",
           "text":"OK"},
 "info":{"hit":3,
          "facet":{"tod":{"13":2},
                   "shk":{"13107":1,
                          "13210":1}},
 "item":[{"code":"30000000000000009425",
          "name":"ドトールコーヒーショップ豊洲メトロピア店",
          "point":{"lat":35.6522222,
                   "lon":139.7993528},
          "addressText":"東京都江東区",
          "addresscode":"13210",
          "floor":1}...]}
キー名 データ型 説明
status     object ステータス情報
  code   string ステータスコード
OK 正常終了
ERR_FORCED_
TERMINATION
タイムアウトが発生またはデータサイズが制限値を超えたため処理を中断
  text   string ステータス内容に関するテキスト情報
info     object 検索結果の情報
  hit   number 検索結果総数
  facet   object ファセット情報
    tod object 都道府県毎の件数
    shk object 市区町村毎の件数
item     array 検索結果の配列
0件の場合は空の配列です。
  code   string 建物コード
  name   string 建物名称
  point   object 緯度経度
  addreaaText   string 住所名称
  addressCode   string 住所コード
  floor   number 階層レベル
出力例

[例 3件の場合]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/building/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&町,新宿&addrcode=11,13,22&limit=1,3

{"status":{"code":"OK",
           "text":"正常終了"},
 "info":{"hit":58,
         "facet":{"tod":{"11":3,
                         "13":52,
                         "22":3},
                  "shk":{"11201":3,
                         "13104":52,
                         "22203":3}}},
 "item":[{"code":"7-22-50-351-8084093",
          "name":"新宿二十騎町郵政宿舎2号棟",
          "point":{"lat":35.6948861,
                   "lon":139.7339722},
          "addressText":"東京都新宿区二十騎町1‐34",
          "addressCode":"13104",
          "floor":3},
         {"code":"7-22-50-25-26553681",
          "name":"新宿二十騎町郵政宿舎1号棟",
          "point":{"lat":35.694675,
                   "lon":139.7339528},
          "addressText":"東京都新宿区二十騎町1‐10",
          "addressCode":"13104",
          "floor":3},
         {"code":"7-22-50-49-3655997",
          "name":"レオパレスエスポワール新宿町",
          "point":{"lat":35.8984806,
                   "lon":139.4825139},
          "addressText":"埼玉県川越市新宿町5丁目15‐2",
          "addressCode":"11201",
          "floor":4}]}

[例 0件の場合]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/building/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=町,新宿&addrcode=23,24&lomit=1,50

{"status":{"code":"OK",
           "text":"正常終了"},
 "info":{"hit":0,
         "facet":null},
 "item":[]}