フリーワードでの交差点検索

API名: 
intersection/word
概要: 

フリーワードから該当する交差点情報を検索します。

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

URI: 

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/intersection/word

<API使用例>

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/intersection/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=寺,町,&addrcode=11,13&limit=1,3
リクエストパラメータ
パラメータ 必須 デフォルト値 説明
word ○ - 検索ワード
検索語句を指定します。
複数値指定で AND または OR 検索ができます。
複数値指定の上限は5件で1語句の上限は1024文字です。
本項目は必須項目であるため、未指定の場合はエラーとなります。
srchtype   and 検索タイプ
word パラメータを複数値指定した場合の検索タイプを指定します。
指定値 説明
and AND 検索
or OR 検索
addrcode   00 絞込み住所コード
検索範囲を指定の住所コードに限定します。市区町村までのコード(2桁または5桁)を指定できます。
複数指定できますが、市区町村を指定する場合は同一都道府県に限定されます。
00を含めた複数指定の場合はエラーとなります。
trafficlight   off 信号機
信号機の有無を指定します。
指定値 説明
ff 信号機有無の絞込みを行わない
none 信号機なし交差点を取得
exist 信号機あり交差点を取得
datum   TOKYO 測地系
返却される住所代表点の測地系を指定します。
limit   0,100 検索結果取得件数
検索結果取得件数を指定します。
取得開始位置の指定範囲は 0～10000 です。
10001 以上の指定をした場合は10000 指定と同様の結果となります。
取得件数の指定範囲は 1~1000 です。
1001以上の指定をした場合は1000指定と同様の結果となります。
llunit   dec 緯度経度形式
緯度経度形式を指定します。
sort   -score 出力順
出力順を指定します。
複数値指定できます。
デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付加します。
指定値 説明
score マッチングスコア
nm 交差点名称
kn 交差点カナ
tod 都道府県コード
fnm 完全一致
snm 前方一致
nmlen 名称の文字数

出力データ
出力フォーマット
{"status":{"code":"OK",
           "text":"正常終了"},
 "info":{"hit":3,
         "facet":{"tod":{"13":2},
                  "shk":{"13107":1,
                         "13210":1}},
 "item":[{"code":"30000000000000009425",
          "name":"表参道交差点",
          "kana":"オモテサンドウコウサテン",
          "point":{"lat":35.6619698,
                   "lon":139.71568771},
          "addressText":"東京都港区",
          "addressCode":"13103",
          "trafficLight":true}
          ...]}
キー名 データ型 説明
status     object ステータス情報が入ります。
  code   string ステータスコードが入ります。
OK 正常終了
ERR_FORCED_
TERMINATION		 タイムアウトが発生またはデータサイズが
制限値を超えたため処理が中断された
  text   string ステータス内容に関するテキスト情報が入ります。
info     object 検索結果の情報が入ります。
  hit   number 入力された条件に対してヒットした件数が入ります。
  facet   object ファセット情報が入ります。
    tod object 都道府県毎の件数が入ります。
形式は{"都道府県コード":件数}です。
    shk object 市区町村毎の件数が入ります。
形式は{"市区町村コード":件数}です。
item     array 検索結果の配列が入ります。
検索結果が0件の場合は空の配列となります。
不明な項目についてはnullで返却します。
  code   string 交差点コードが入ります。
  name   string 交差点名称が入ります。
  kana   string 交差点カナが入ります。
  point   object 代表点緯度経度が入ります。
  addressText   string 住所名称が入ります。
  addressCode   string 住所コードが入ります。
  trafficLight   boolean 信号機の有無が入ります。

出力例

[通常出力例]

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/intersection/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=寺,町,&addrcode=11,13&limit=1,3
{"status":{"code":"OK",
    "text":"正常終了"},
 "info":{"hit": 10,
         "facet":{"tod":{"13":10},
                  "shk":{"13104": 1,
                         "13112": 1,
                         "13201": 4,
                         "13203": 3,
                         "13214": 1}}},
 "item":[{"code": "533932-598",
          "name": "寺田町東",
          "kana": "てらだまちひがし",
          "point": {
          "lat": 35.6281203,
          "lon": 139.3148975},
          "addressText": "東京都八王子市寺田町１７５",
          "addressCode": "13201",
          "trafficLight": true},
          ...]}

[検索結果が0件の例]

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/intersection/word?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&word=町,新宿&addrcode=23,24&limit=1,50
{"status":{"code":"OK",
           "text":"正常終了"},
 "info":{"hit":0,
         "facet":null},
 "item":[]}