電話番号でのPOI検索
API名:
poi/phonenumber
概要:
リクエストパラメータで指定される電話番号を元にPOIデータベースを検索し、POI情報を返却します。
※多言語情報の出力には別途契約が必要です。
※全ての地下街・駅構内詳細図情報の出力が基本契約内でご利用頂けることになりました。
ご利用をご希望の方は営業にお申し出ください。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/phonenumber
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/phonenumber?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&phonenumber=0311
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| phonenumber | ○ | - |
検索電話番号 検索電話番号を指定します。複数指定はできません。 2文字以上64文字以下の数値で指定し、半角ハイフンも使用できますが先頭や末尾で使うとエラーになります。 「--」のように連続して使うこともできません。 本項目は必須項目であるため、未指定の場合はエラーとなります。 |
||||
| genrecode | - |
絞込みジャンルコード 検索範囲を指定のジャンルコードに限定します。 5桁または10桁のコードで指定します。 複数値指定するとOR検索で絞込みされます。 ジャンルコードの取得はジャンルコード一覧取得APIを使用してください。 ジャンルコード一覧は下記より閲覧、ダウンロードできます。 ・ジャンルコード一覧(Excel) |
|||||
| datum | TOKYO |
測地系 返却される住所代表点の測地系を指定します。 |
|||||
| limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|||||
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|||||
| detailid | - | 詳細図番号を指定します。 | |||||
| notmultilanguage | F |
多言語情報出力 検索結果に多言語情報を含まないかを真偽値で指定します。 本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。
|
出力データ
出力フォーマット
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":1, "facet":{"tod":{"13":1}, "shk":{"13114":1}, "genre":{"0011000260":{"text":"車・交通/駅", "count":1}}, "areaInfo":string, "detailInfo":{"00000080":{"text":"中野新橋駅(東京メトロ 丸ノ内線)", "count":1}}, "genreMlang":null}}, "item":[{"text":"中野新橋駅(東京メトロ 丸ノ内線)", "code":"20000000000000003235", "point":{"lat":35.6892528, "lon":139.6774639}, "kana":"ナカノシンバシエキトウキョウチカテツ/ヨンゴウマルノウチセン", "addressText":"東京都中野区弥生町２丁目２６－８", "zipcode":"164-0013", "phoneNumber":"03-3381-1102", "genre":{"code":"0011000260", "text":"車・交通/駅"}, "detail":{"areaid":string, "areaname":string, "detailid":string, "detailname":string, "floorname":string, "level":string}, "language":{"zh-cn":{"text":"中野新桥站(东京Metro地铁 丸之内线)", "addressParts":["东京都","中野区","弥生町","2丁目","26","8"], "genre":"车，交通/车站"}, "zh-tw":{"text":"中野新橋站(東京Metro地鐵 丸之內線)", "addressParts":["東京都","中野區","彌生町","2丁目","26","8"], "genre":"車，交通/車站"}, "en":{"text":"Nakano-shinbashi (Tokyo Metro Marunouchi Line)", "addressParts":["Tokyo","Nakano","Yayoicho","2","26","8"], "genre":"Transportation/Station"}, "ko":{"text":"나카노신바시 역(도쿄 메트로 마루노우치선)", "addressParts":["도쿄도","나카노구","야요이쵸","2쵸메","26","8"], "genre":"차/교통/역"}}, "arrivalInfo":[{"text":"出口", "kana":"デグチ", "exittype":{"code":"11", "text":"地下鉄出入口"}, "arrivalpoint":{"lat":35.6893306, "lon":139.6775556}, "exitpoint":{"lat":35.6892917, "lon":139.6775556}}]}]}
| キー名 | データ型 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
| 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 | array |
POI情報の配列が入ります。 検索結果が0件の場合は空の配列となります。 |
||||||
出力例
[通常出力例(多言語情報出力契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/phonenumber?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&phonenumber=03-3381-1102
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 1, "facet": { "tod": { "13": 1 }, "shk": { "13114": 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": "20000000000000003235", "point": { "lat": 35.6892528, "lon": 139.6774639 }, "kana": "ナカノシンバシエキトウキョウチカテツ/ヨンゴウマルノウチセン", "addressText": "東京都中野区弥生町２丁目２６－８", "zipcode": "164-0013", "phoneNumber": "03-3381-1102", "genre": { "code": "0011000260", "text": "車・交通/駅" }, "detail": null, "language": { "zh-cn": { "text": "中野新桥站(东京Metro地铁丸之内线)", "addressParts": [ "东京都", "中野区", "弥生町", "2丁目", "26", "8" ], "genre": "车，交通/车站" }, "zh-tw": { "text": "中野新橋站(東京Metro地鐵丸之內線)", "addressParts": [ "東京都", "中野區", "彌生町", "2丁目", "26", "8" ], "genre": "車，交通/車站" }, "en": { "text": "Nakano-Shimbashi (Tokyo Metro Marunouchi Line)", "addressParts": [ "Tokyo", "Nakano", "Yayoicho", "2", "26", "8" ], "genre": "Transportation/Station" }, "ko": { "text": "나카노신바시 역(도쿄메트로 마루노우치선)", "addressParts": [ "도쿄도", "나카노구", "야요이쵸", "2쵸메", "26", "8" ], "genre": "차/교통/역" } }, "arrivalInfo": [ { "text": "出口", "kana": "デグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6893306, "lon": 139.6775556 }, "exitpoint": { "lat": 35.6892917, "lon": 139.6775556 } } ] } ] }
[通常出力例(多言語情報出力未契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/phonenumber?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&phonenumber=03-3381-1102
{ "status": { "code": "0000", "text": "OK" }, "info": { "hit": 1, "facet": { "tod": { "13": 1 }, "shk": { "13114": 1 }, "genre": { "0011000260": { "text": "車・交通/駅", "count": 1 } }, "areaInfo": null, "detailInfo": null, "genreMlang": null } }, "item": [ { "text": "中野新橋駅(東京メトロ 丸ノ内線)", "code": "20000000000000003235", "point": { "lat": 35.6892528, "lon": 139.6774639 }, "kana": "ナカノシンバシエキトウキョウチカテツ/ヨンゴウマルノウチセン", "addressText": "東京都中野区弥生町２丁目２６－８", "zipcode": "164-0013", "phoneNumber": "03-3381-1102", "genre": { "code": "0011000260", "text": "車・交通/駅" }, "detail": null, "language": null, "arrivalInfo": [ { "text": "出口", "kana": "デグチ", "exittype": { "code": "11", "text": "地下鉄出入口" }, "arrivalpoint": { "lat": 35.6893306, "lon": 139.6775556 }, "exitpoint": { "lat": 35.6892917, "lon": 139.6775556 } } ] } ] }
[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/phonenumber?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&phonenumber=111111
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":0, "facet":null}, "item":[]}