poi
施設検索
施設情報の検索を行います。
施設フリーワード検索
施設名を指定してフリーワード検索できます。
施設ジャンルのジャンルコードを指定してリスト検索する事ができます。
施設ジャンルリスト返却
住所コード、施設ジャンルコードを取得できます。
取得したコードを指定すると、配下の施設ジャンルコードを取得できます。
施設ジャンルフリーワード検索
指定された施設名が属する施設ジャンルのジャンルコードの情報を検索します。
検索条件を複数指定した場合はAND結合となります。
HTTP request method
POST/GET
ContentType
application/x-www-form-urlencoded
Parameters
*requiredは必須
| 名前 | 説明 |
|---|---|
| genre_pattern*required string |
ジャンルパターンを指定 ジャンルコードを指定する場合やword検索でジャンルを含めたい場合は必須です。 指定可能な値:101,102 |
| word string |
名称、読みを指定 複数ワードはスペース区切りで指定してください。AND検索となります。 最大文字数 1024 |
| word_match_type integer default 3 |
検索語句のマッチタイプを指定
|
| address_code_list array[string] ※カンマ区切り |
住所コードを指定(前方一致) 複数指定の場合はOR検索となります。 各住所コードの最大文字数 255 指定できる値は最大50件 |
| proximity array[number] ※カンマ区切り |
中心座標、半径で範囲を指定 代表点の近傍検索。 "経度,緯度,半径(m)"で指定してください。 半径の上限は5000です。 |
| phone_number string |
電話番号を指定(完全一致) ハイフンは削除して検索します。 |
| genre_code array[string] ※カンマ区切り |
ジャンルコードを指定(完全一致) ジャンルコードをレベル1とレベル2のコロン(:)区切りで指定(複数指定可) 複数指定する場合はカンマ区切りで指定します。 指定できる値は最大50件 例)00010:0001000015,00010:0001000020,00020:0002000020 |
| sort array[string] ※カンマ区切り |
出力順を指定(複数指定可) デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。 デフォルト指定はありません(順不同)。 zid
建物ZID
zid_attr
属性ZID
id
ID(地物)
id_attr
ID(属性)
name
名称
name_read
名称読み
distance
検索座標と建物代表点の直線距離
genre_code
ジャンルコード
|
| facet array[string] ※カンマ区切り |
取得するファセットフィールド名を指定 ジャンル毎の取得件数(カンマ区切り)を取得する事ができます。 指定可能な値:genre_facet |
| limit array[integer] default List[0,100] ※カンマ区切り |
検索結果取得件数を"オフセット,件数"で指定 最大値 2000,1000 |
| datum string default JGD |
入出力座標の測地系を指定 JGD
世界測地系
TOKYO
日本測地系
TOKYO_NAVI
日本測地系(ゼンリン ナビ地図)
|
Responses
エラーについては「エラーメッセージ一覧」を参照してください。
Media type:application/json
| キー名 | 説明 | ||
|---|---|---|---|
|
|
ステータス | ||
|
|
|
hit integer |
検索結果総数 |
|
|
genre_facet number string |
facetの指定がある場合のみ出力 値,件数の配列で出力します。 配列最後のペアは指定のジャンルパターンに紐づかないレコードの件数が"NOT_FOUND",件数として含まれます。 例)["05080000_140:140180_[お買い物][コンビニ]",57441,"07020000_170:170130_[金融・郵便局][郵便局]",21766,"NOT_FOUND",31337] |
|
|
|
zid string |
建物ZID 建物等の地物毎にふられるパーマネントのID |
|
| zid_attr string |
属性ZID 地物内のテナント施設等といった属性情報毎にふられるパーマネントのID |
||
| id string |
ID(地物) 建物ZIDを0パディングし22桁に揃えた文字列 |
||
| id_attr string |
ID(属性) 属性ZIDを0パディングし22桁に揃えた文字列 |
||
| building_name string |
建物名称 | ||
| name string |
施設名称 | ||
| name_read string |
施設名称読み | ||
| name_read_through string |
施設名称読み下し 読みと読み下しの違いは以下の通り ・読み ：英数字は英数字のまま返却 ・読み下し：英数字の読みを返却（例：１→イチ、A→エー） ※いずれか、もしくはいずれもnullで返却される場合があります |
||
| name_initial_code string |
施設名称あかさたなコード
|
||
| phone_number string |
電話番号 | ||
| post_code string |
郵便番号 | ||
| address_code string |
住所コード | ||
| address_code1 string |
国コード | ||
| address_code2 string |
都道府県コード | ||
| address_code3 string |
市区町村コード | ||
| address_code4 string |
大字コード | ||
| address_code5 string |
字丁目コード | ||
| address_detail_code1 string |
街区コード | ||
| address_detail_code2 string |
地番戸番コード | ||
| address string |
住所 | ||
| building_type integer |
区分 | ||
| endearing_name_type integer |
呼び名種別 名称がどのような名称であるかを表す種別
|
||
| language_code string |
言語コード "ja"のみ |
||
| entrance_point array[array[number]] |
出入口地点座標 座標の配列(複数点の場合あり)を返却します。 [[経度,緯度],...] |
||
| arrival_point array[array[number]] |
到着地点緯座標 座標の配列(複数点の場合あり)を返却します。 [[経度,緯度],...] |
||
| genre_code string |
ジャンルコード | ||
| main_genre_name string |
メインジャンル名称 施設の属するジャンルを表す。 該当するジャンルが複数存在する場合、すべて返却します。 |
||
| all_genre_name string |
ジャンル名称(セミコロン区切り) 施設の属するジャンルを表す。 該当するジャンルが複数存在する場合、複数ジャンル名称を連結して返却します。 |
||
| position array[number] |
["経度","緯度"] | ||
| distance number |
検索座標と代表点の直線距離(proximityを指定した場合のみ返却) | ||
Example
https://[domain]/search/poi?genre_pattern=102&word_match_type=3&facet=genre_facet&limit=0,100&datum=JGD
{
"status": "OK",
"result": {
"info": {
"hit": 948451
},
"facet": {
"genre_facet": [
"01010000_00010:0001000010_[交通][駅(鉄道)]",
11364,
"01020000_00010:0001000015_[交通][バスターミナル]",
346,
...
]
},
"item": [
{
"zid": "306334392911948179",
"zid_attr": "1747953049910981118",
"id": "0000306334392911948179",
"id_attr": "0001747953049910981118",
"building_name": "町立西表小・中学校",
"name": "竹富町立西表小学校",
"name_read": null,
"name_read_through": "タケトミチョウリツイリオモテショウガッコウ",
"name_initial_code": "99",
"phone_number": "0980-85-6454",
"post_code": null,
"address_code": "473810020000000000104",
"address_code1": "JPN",
"address_code2": "47",
"address_code3": "381",
"address_code4": "002",
"address_code5": "000",
"address_detail_code1": "00000",
"address_detail_code2": "00104",
"address": "沖縄県八重山郡竹富町字西表869",
"building_type": 1,
"endearing_name_type": 1,
"language_code": "ja",
"entrance_point": [
[
123.748988715278,
24.3903534613715
]
],
"arrival_point": [
[
123.748956705729,
24.3903461371528
]
],
"genre_code": "00050:0005000060; ",
"main_genre_name": "0005000060:小学",
"all_genre_name": "教育;小学;",
"position": [
123.74896511501736,
24.39077311197917
],
"distance": null
},
{
"zid": "306354184121234004",
"zid_attr": "1751089956584982735",
"id": "0000306354184121234004",
"id_attr": "0001751089956584982735",
"building_name": "町立船浮小・中学校",
"name": "竹富町立船浮小学校",
"name_read": null,
"name_read_through": "タケトミチョウリツフナウキショウガッコウ",
"name_initial_code": "99",
"phone_number": "0980-85-6354",
"post_code": null,
"address_code": "473810020000000000027",
"address_code1": "JPN",
"address_code2": "47",
"address_code3": "381",
"address_code4": "002",
"address_code5": "000",
"address_detail_code1": "00000",
"address_detail_code2": "00027",
"address": "沖縄県八重山郡竹富町字西表2435",
"building_type": 1,
"endearing_name_type": 1,
"language_code": "ja",
"entrance_point": null,
"arrival_point": null,
"genre_code": "00050:0005000060; ",
"main_genre_name": "0005000060:小学",
"all_genre_name": "教育;小学;",
"position": [
123.7287339952257,
24.339102918836804
],
"distance": null
},
...
]
}
}