ポリラインでの周辺のPOI情報検索

API名:

poi/polyline

概要:

リクエストパラメータで指定されるポリラインを元に周辺のPOI情報を返却します。

指定したポリライン距離が長くなるほど検索速度は遲くなります。

URI:

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/polyline

<API使用例>

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/polyline?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&line=35.6618472,139.76095,35.661605,139.760819,35.661480,139.760747&buffer=20

リクエストパラメータ

パラメータ

必須

デフォルト値

説明

line

○

ポリライン
緯度経度を2点以上で指定します。

word

検索ワード
検索範囲を指定の施設名称に限定します。
複数値指定で AND または OR 検索ができます。
複数値指定の上限は50件で１語句の上限は1024文字です。

srchtype

and

検索タイプ
word パラメータを複数値指定した場合の検索タイプを指定します。

指定値	説明
and	AND 検索
or	OR 検索

poitype

all

POI情報検索範囲指定
周辺のPOI情報の検索範囲を指定します。
all を指定した場合はポリライン周辺、corner を指定した場合はポリライン上の曲がり角が検索範囲になります。

buffer

検索範囲
クエリパラメータpoitype に all を指定した場合、
ポリラインからどのくらいの範囲を検索対象とするか、片側の幅を指定します。(単位:m)
指定可能な幅は 0～200 です。

cornerradius

検索範囲メートル指定
クエリパラメータpoitype に corner を指定した場合、検索範囲の半径を指定します。(単位:m)
指定可能な幅は 0～200 です。

cornerangle

120

検索範囲角度指定
クエリパラメータpoitype に corner を指定した場合、角判定を行う角度を指定します。
指定した角度以下の角を「角」とします。(単位:°)
指定可能な範囲は0～180です。

datum

TOKYO

測地系
返却される住所代表点の測地系を指定します。

limit

0,100

検索結果取得件数
検索結果取得件数を指定します。
取得開始位置の指定範囲は 0～10000 です。
10001 以上の指定をした場合は10000 指定と同様の結果となります。
取得件数の指定範囲は 1~1000 です。
1001以上の指定をした場合は1000指定と同様の結果となります。

llunit

dec

緯度経度形式
緯度経度形式を指定します。

genrename

絞込みジャンル名
検索範囲を指定したジャンル名に限定します。
複数指定するとOR検索で絞込みされます。
genrecodeと同時指定した場合、エラーとなります。

genrecode

絞込みジャンルコード
検索範囲を指定したジャンルコードに限定します。
複数指定するとOR検索で絞込みされます。
10桁指定する際はメニューIDとジャンルIDの間に:(コロン)を入れてください。
genrenameと同時指定した場合、エラーとなります。
ジャンルコードの取得はジャンルコード一覧取得APIを使用してください。
ジャンルコード一覧は下記よりダウンロードできます。
・ジャンルコード一覧(Excel)

side

all

施設対象絞込み
施設対象をlineの左側、右側への絞込みを指定します。

指定値	説明
all	左右
left	左側のみ
right	右側のみ

sort

dist_route

出力順
出力順を指定します。複数値指定できます。
降順指定の場合はソートキーの前方にマイナス(-)を付加します。

指定値	説明
dist_route	指定したlineの出発点(始点)からの距離
nm	施設名称
kn	施設名カナ
tod	都道府県コード

出力データ

出力フォーマット

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":5},
"item":[{"poi":{"text":"ローソン銀座三丁目店",
"code":"1561370",
"point":{"lat":35.672075,
"lon":139.7678331},
"kana":"ロ－ソンギンザサンチョウメテン",
"addressText":"東京都中央区銀座３丁目８－１",
"zipcode":"104-0061",
"phoneNumber":"03-3563-3731",
"genre":null,
"detail":null,
"language":null,
"arrivalInfo":[]},
"side":"right"},
...]}

キー名

データ型

説明

status

object

ステータス情報が入ります。

code

string

ステータスコードが入ります。

0000	正常終了
0001	タイムアウトが発生またはデータサイズが制限値を超えたため処理が中断された

text

string

ステータス内容に関するテキスト情報が入ります。

info

object

検索結果の情報が入ります。

hit

number

入力された条件に対してヒットした件数が入ります。

item

array

検索結果のオブジェクトが配列で入ります。
検索結果が0件の場合は空の配列となります。

poi

object

POI情報が入ります。

text

string

POI表記文字列が入ります。

code

string

POIコードが入ります。

point

object

代表点緯度経度が入ります。

lat

number

緯度が入ります。

lon

number

経度が入ります。

kana

string

POI名称カナが入ります。

addressText

string

住所テキストが入ります。

zipcode

string

郵便番号が入ります。

phoneNumber

string

電話番号が入ります。

genre

object

ジャンル情報が入ります。

code

string

下位または上位のジャンルコードが入ります。

text

string

ジャンル名称が入ります。

detail

nullが入ります。

language

nullが入ります。

arrivalinfo

空配列が入ります。

side

string

ポリラインの方向に対してのPOI位置が入ります。

right	ポリラインの方向に対してPOIの位置が右側
left	ポリラインの方向に対してPOIの位置が左側

出力例

[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/polyline?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&
line=35.6618472,139.76095,35.661605,139.760819,35.661480,139.760747&buffer=200

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":2},
"item":[{"poi":{"text":"ドトールコーヒーショップ新橋西口通り店",
"code":"00000000000001800091",
"point":{"lat":35.6616417,
"lon":139.7606778},
"kana":"ドトールコーヒーショップシンバシニシグチドオリテン",
"addressText":"東京都港区新橋３－１９－４",
"zipcode":"105-0004",
"phoneNumber":"03-5473-8507",
"genre":null,
"detail":null,
"language":null,
"arrvalInfo":[]},
"side":"right"}
{"poi":{"text":"マンボー新橋2号店",
"code":"00000000000002684064",
"point":{"lat":35.6614722,
"lon":139.7609861},
"kana":"マンボーシンバシニゴウテン",
"addressText":"東京都港区新橋３丁目２３－１",
"zipcode":"105-0004",
"phoneNumber":"03-5733-3949",
"genre":null,
"detail":null,
"language":null,
"arrivalInfo":[]},
"side":"left"}]}

[検索結果が0件の例]

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":0},
"item":[]}