ジャンルコードでのPOI検索
API名:
poi/genrecode
概要:
リクエストパラメータで指定されるジャンルコードに該当するPOI情報を返却します。
※多言語情報の出力には別途契約が必要です。
※全ての地下街・駅構内詳細図情報の出力が基本契約内でご利用頂けることになりました。
ご利用をご希望の方は営業にお申し出ください。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecode
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0014000240;0014000250&addrcode=13106
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| genrecode | ○ | - |
ジャンルコード 5桁または10桁のコードで指定します。複数値指定するとOR検索になります。 ジャンルコードの取得はジャンルコード一覧取得APIを使用してください。 ジャンルコード一覧は下記よりダウンロードできます。 ・ジャンルコード一覧(Excel) |
||||
| word | - |
絞り込み施設名称 検索範囲を指定の施設名称に限定します。 50件を上限に複数検索できます。 1語句の上限は1024文字です。 |
|||||
| addrcode | - |
絞込み住所コード 検索範囲を指定の住所コードに限定します。 市区町村までのコード(2桁または5桁)を指定できます。 複数指定できますが、市区町村を指定する場合は同一都道府県に限定されます。 |
|||||
| datum | TOKYO |
測地系 返却される住所代表点の測地系を指定します。 |
|||||
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|||||
| limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000 指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|||||
| srchtype | and |
検索タイプ word パラメータを複数指定した場合の検索タイプを指定します。
|
|||||
| detailid | - |
地下街・駅構内詳細図番号 地下街・駅構内詳細図番号を指定します。 |
|||||
| notmultilanguage | F |
多言語情報出力 検索結果に多言語情報を含まないかを真偽値で指定します。 本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。
|
出力データ
出力フォーマット
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 1, "facet": { "tod": { "13": 1 }, "shk": { "13102": 1 }, "genre": { "0011000260": { "text": "車・交通/駅", "count": 1 } }, "areaInfo": null, "detailInfo": null, "genreMlang": { "zh-cn": { "0011000260": { "text": "车，交通/车站", "count": 1 } }, "zh-tw": { "0011000260": { "text": "車，交通/車站", "count": 1 } }, "en": { "0011000260": { "text": "Transportation/Station", "count": 1 } }, "ko": { "0011000260": { "text": "차/교통/역", "count": 1 } } } } }, "item": [ { "text": "勝どき駅(都営地下鉄 大江戸線)", "code": "20000000000000003552", "point": { "lat": 35.6552667, "lon": 139.779675 }, "kana": "カチドキエキトウキョウトコウツウキョク/ジュウニゴウオオエドセン", "addressText": "東京都中央区勝どき２－１０－１５先", "zipcode": "104-0054", "phoneNumber": "03-3536-7441", "genre": { "code": "0011000260", "text": "車・交通/駅" }, "detail": null, "language": { "zh-cn": { "text": "胜哄站(都营地铁大江户线)", "addressParts": [ "东京都", "中央区", "胜Doki", "2" ], "genre": "车，交通/车站" }, "zh-tw": { "text": "勝鬨站(都營地鐵大江戶線)", "addressParts": [ "東京都", "中央區", "勝Doki", "2" ], "genre": "車，交通/車站" }, "en": { "text": "Kachidoki (Toei Subway Oedo Line)", "addressParts": [ "Tokyo", "Chuo", "Kachidoki", "2" ], "genre": "Transportation/Station" }, "ko": { "text": "카치도키 역(도쿄도교통국 오에도선)", "addressParts": [ "도쿄도", "츄오구", "카치도키", "2" ], "genre": "차/교통/역" } }, "arrivalInfo": [ { "text": "Ａ１", "kana": "エーイチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.656325, "lon": 139.7811194 }, "exitpoint": { "lat": 35.6564333, "lon": 139.7810306 } }, ... ] } ] }
| キー名 | データ型 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
| status | object | ステータス情報を返却します。 | ||||||
| code | string |
ステータスコードを返却します
|
||||||
| text | string | ステータス内容に関するテキスト情報を返却します。 | ||||||
| info | object | 検索結果の情報を返却します。 | ||||||
| hit | number | 検索結果総数を返却します。 | ||||||
| facet | object | ファセット情報を返却します。 | ||||||
| tod | object | 都道府県毎の件数を返却します。 | ||||||
| shk | object | 市区町村毎の件数を返却します。 | ||||||
| genre | object | ジャンルコード毎の件数を返却します。 | ||||||
| areaInfo | object | エリア毎の件数が入ります。 | ||||||
| detailInfo | object | 詳細図番号毎の件数が入ります。 | ||||||
| genreMlang | object | 言語別ジャンルコード毎の件数が入ります。 | ||||||
| item | object |
POI情報の配列が入ります。 検索結果が0件の場合は空の配列となります。 出力順は施設名カナの昇順となります。 |
||||||
出力例
[通常出力例(多言語情報出力契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0011000260&addrcode=13102&word=勝どき
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 1, "facet": { "tod": { "13": 1 }, "shk": { "13102": 1 }, "genre": { "0011000260": { "text": "車・交通/駅", "count": 1 } }, "areaInfo": null, "detailInfo": null, "genreMlang": { "zh-cn": { "0011000260": { "text": "车，交通/车站", "count": 1 } }, "zh-tw": { "0011000260": { "text": "車，交通/車站", "count": 1 } }, "en": { "0011000260": { "text": "Transportation/Station", "count": 1 } }, "ko": { "0011000260": { "text": "차/교통/역", "count": 1 } } } } }, "item": [ { "text": "勝どき駅(都営地下鉄 大江戸線)", "code": "20000000000000003552", "point": { "lat": 35.6552667, "lon": 139.779675 }, "kana": "カチドキエキトウキョウトコウツウキョク/ジュウニゴウオオエドセン", "addressText": "東京都中央区勝どき２－１０－１５先", "zipcode": "104-0054", "phoneNumber": "03-3536-7441", "genre": { "code": "0011000260", "text": "車・交通/駅" }, "detail": null, "language": { "zh-cn": { "text": "胜哄站(都营地铁大江户线)", "addressParts": [ "东京都", "中央区", "胜Doki", "2" ], "genre": "车，交通/车站" }, "zh-tw": { "text": "勝鬨站(都營地鐵大江戶線)", "addressParts": [ "東京都", "中央區", "勝Doki", "2" ], "genre": "車，交通/車站" }, "en": { "text": "Kachidoki (Toei Subway Oedo Line)", "addressParts": [ "Tokyo", "Chuo", "Kachidoki", "2" ], "genre": "Transportation/Station" }, "ko": { "text": "카치도키 역(도쿄도교통국 오에도선)", "addressParts": [ "도쿄도", "츄오구", "카치도키", "2" ], "genre": "차/교통/역" } }, "arrivalInfo": [ { "text": "Ａ１", "kana": "エーイチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.656325, "lon": 139.7811194 }, "exitpoint": { "lat": 35.6564333, "lon": 139.7810306 } }, { "text": "Ａ２ｂ", "kana": "エーニビー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6563583, "lon": 139.7813917 }, "exitpoint": { "lat": 35.6563028, "lon": 139.7814472 } }, { "text": "Ａ３", "kana": "エーサン", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6556194, "lon": 139.7803056 }, "exitpoint": { "lat": 35.6555556, "lon": 139.7803639 } }, { "text": "Ａ４ｂ", "kana": "エーヨンビー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6558944, "lon": 139.7805056 }, "exitpoint": { "lat": 35.6559444, "lon": 139.7804556 } }, { "text": "Ａ２ａ", "kana": "エーニエー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6562639, "lon": 139.7812444 }, "exitpoint": { "lat": 35.6562111, "lon": 139.7813167 } }, { "text": "Ａ４ａ", "kana": "エーヨンエー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6558389, "lon": 139.7804278 }, "exitpoint": { "lat": 35.6561444, "lon": 139.7801667 } }, { "text": "Ａ３ｂ", "kana": "エーサンビー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6557417, "lon": 139.7804833 }, "exitpoint": { "lat": 35.6556694, "lon": 139.7805306 } } ] } ] }
[通常出力例(多言語情報出力未契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0011000260&addrcode=13102&word=勝どき
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 1, "facet": { "tod": { "13": 1 }, "shk": { "13102": 1 }, "genre": { "0011000260": { "text": "車・交通/駅", "count": 1 } }, "areaInfo": null, "detailInfo": null, "genreMlang": null } }, "item": [ { "text": "勝どき駅(都営地下鉄 大江戸線)", "code": "20000000000000003552", "point": { "lat": 35.6552667, "lon": 139.779675 }, "kana": "カチドキエキトウキョウトコウツウキョク/ジュウニゴウオオエドセン", "addressText": "東京都中央区勝どき２－１０－１５先", "zipcode": "104-0054", "phoneNumber": "03-3536-7441", "genre": { "code": "0011000260", "text": "車・交通/駅" }, "detail": null, "language": null, "arrivalInfo": [ { "text": "Ａ１", "kana": "エーイチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.656325, "lon": 139.7811194 }, "exitpoint": { "lat": 35.6564333, "lon": 139.7810306 } }, { "text": "Ａ２ｂ", "kana": "エーニビー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6563583, "lon": 139.7813917 }, "exitpoint": { "lat": 35.6563028, "lon": 139.7814472 } }, { "text": "Ａ３", "kana": "エーサン", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6556194, "lon": 139.7803056 }, "exitpoint": { "lat": 35.6555556, "lon": 139.7803639 } }, { "text": "Ａ４ｂ", "kana": "エーヨンビー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6558944, "lon": 139.7805056 }, "exitpoint": { "lat": 35.6559444, "lon": 139.7804556 } }, { "text": "Ａ２ａ", "kana": "エーニエー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6562639, "lon": 139.7812444 }, "exitpoint": { "lat": 35.6562111, "lon": 139.7813167 } }, { "text": "Ａ４ａ", "kana": "エーヨンエー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6558389, "lon": 139.7804278 }, "exitpoint": { "lat": 35.6561444, "lon": 139.7801667 } }, { "text": "Ａ３ｂ", "kana": "エーサンビー", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6557417, "lon": 139.7804833 }, "exitpoint": { "lat": 35.6556694, "lon": 139.7805306 } } ] } ] }
[検索結果が0件の場合]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/genrecode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&genrecode=0099999999&addrcode=13106
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":0, "facet":null}, "item":[]}