地下街・駅構内詳細図番号でのPOI検索

API名: 
poi/detailid
概要: 

リクエストパラメータで指定される地下街・駅構内詳細図番号に該当するPOI情報を返却します。

※多言語情報の出力には別途契約が必要です。
※全ての地下街・駅構内詳細図情報の出力が基本契約内でご利用頂けることになりました。
ご利用をご希望の方は営業にお申し出ください。

URI: 

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

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/detailid?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&detailid=00000001

リクエストパラメータ
パラメータ 必須 デフォルト値 説明
detailid ○ - 地下街・駅構内詳細図番号
地下街・駅構内詳細図番号を指定します。
複数値指定ができます。
word   - 検索ワード
検索語句を指定します。
複数値指定で AND または OR 検索ができます。
複数値指定の上限は50件で１語句の上限は1024文字です。
本項目は必須項目であるため、未指定の場合はエラーとなります。
srchtype   and 検索タイプ
word パラメータを複数値指定した場合の検索タイプを指定します。
and AND 検索
or OR 検索
genrecode   - 絞込みジャンルコード
検索範囲を指定のジャンルコードに限定します。
5桁または10桁のコードで指定します。
複数値指定するとOR検索で絞込みされます。
ジャンルコードの取得はジャンルコード一覧取得APIを使用してください。
ジャンルコード一覧は下記よりダウンロードできます。
・ジャンルコード一覧(Excel)
datum   TOKYO 測地系
返却される住所代表点の測地系を指定します。
limit   0,100 検索結果取得件数
検索結果取得件数を指定します。
取得開始位置の指定範囲は 0～10000 です。
10001 以上の指定をした場合は10000 指定と同様の結果となります。
取得件数の指定範囲は 1~1000 です。
1001以上の指定をした場合は1000指定と同様の結果となります。
llunit   dec 緯度経度形式
緯度経度形式を指定します。

出力データ
出力フォーマット
{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":2,
         "facet":{"tod":{"13":2},
                  "shk":{"13101":2},
                  "genre":{"0014000180":{"text":"買い物/コンビニ",
                                         "count":2}},
                  "areaInfo":{"003":{"text":"東京・有楽町・銀座・新橋エリア",
                                     "count":2}},
                  "detailInfo":{"00000101":{"text":"東京メトロ大手町駅",
                                            "count":2}}}},
 "item":[{"text":"ナチュラルローソン大手町西メトロピア店",
          "code":"00000000000002803428",
          "point":{"lat":35.68375,
                   "lon":139.7671556},
          "kana":"ナチュラルローソンオオテマチニシメトロピアテン",
          "addressText":"東京都千代田区大手町１－６－１",
          "zipcode":"100-0004",
          "phoneNumber":"03-5288-6688",
          "genre":{"code":"0014000180",
                   "text":"買い物/コンビニ"},
          "detail":{"areaid":"003",
                    "areaname":"東京・有楽町・銀座・新橋エリア",
                    "detailid":"00000101",
                    "detailname":"東京メトロ大手町駅",
                    "floorname":"地下２階",
                    "level":"-2"},
          "language":null,
          "arrivalInfo":[{"text":"出入口",
                          "kana":"デイリグチ",
                          "exittype":{"code":"99",
                                      "text":"未調査"},
                          "arrivalpoint":{"lat":35.6839444,
                                          "lon":139.7668972},
                          "exitpoint":{"lat":35.6839444,
                                       "lon":139.7668972}}]},
          ...]}
キー名 データ型 説明
status     object ステータス情報が入ります。
  code   string ステータスコードが入ります。
0000 正常終了
0001 タイムアウトが発生またはデータサイズが
制限値を超えたため処理が中断された
  text   string ステータス内容に関するテキスト情報が入ります。
info     object 検索結果の情報が入ります。
  hit   number 入力された条件に対してヒットした件数が入ります。
  facet   object ファセット情報が入ります。
    tod object 都道府県毎の件数が入ります。
    shk object 市区町村毎の件数が入ります。
    genre object ジャンルコード毎の件数が入ります。
    areaInfo object エリア毎の件数が入ります。
    detailInfo object 詳細図番号毎の件数が入ります。
item     array POI情報の配列が入ります。
検索結果が0件の場合は空の配列となります。

出力例

[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/detailid?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&detailid=00000101

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":2,
         "facet":{"tod":{"13":2},
                  "shk":{"13101":2},
                  "genre":{"0014000180":{"text":"買い物/コンビニ",
                                         "count":2}},
                  "areaInfo":{"003":{"text":"東京・有楽町・銀座・新橋エリア",
                                     "count":2}},
                  "detailInfo":{"00000101":{"text":"東京メトロ大手町駅",
                                            "count":2}}}},
 "item":[{"text":"ナチュラルローソン大手町西メトロピア店",
          "code":"00000000000002803428",
          "point":{"lat":35.68375,
                   "lon":139.7671556},
          "kana":"ナチュラルローソンオオテマチニシメトロピアテン",
          "addressText":"東京都千代田区大手町１－６－１",
          "zipcode":"100-0004",
          "phoneNumber":"03-5288-6688",
          "genre":{"code":"0014000180",
                   "text":"買い物/コンビニ"},
          "detail":{"areaid":"003",
                    "areaname":"東京・有楽町・銀座・新橋エリア",
                    "detailid":"00000101",
                    "detailname":"東京メトロ大手町駅",
                    "floorname":"地下２階",
                    "level":"-2"},
          "language":null,
          "arrivalInfo":[{"text":"出入口",
                          "kana":"デイリグチ",
                          "exittype":{"code":"99",
                                      "text":"未調査"},
                          "arrivalpoint":{"lat":35.6839444,
                                          "lon":139.7668972},
                          "exitpoint":{"lat":35.6839444,
                                       "lon":139.7668972}}]},
         {"text":"ナチュラルローソン大手町メトロピア店",
          "code":"00000000000002803515",
          "point":{"lat":35.6819944,
                   "lon":139.7662889},
          "kana":"ナチュラルローソンオオテマチメトロピアテン",
          "addressText":"東京都千代田区大手町１丁目６－１",
          "zipcode":"100-0004",
          "phoneNumber":"03-5220-5607",
          "genre":{"code":"0014000180",
                   "text":"買い物/コンビニ"},
          "detail":{"areaid":"003",
                    "areaname":"東京・有楽町・銀座・新橋エリア",
                    "detailid":"00000101",
                    "detailname":"東京メトロ大手町駅",
                    "floorname":"地下２階",
                    "level":"-2"},
          "language":null,
          "arrivalInfo":[]}]}



[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/detailid?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&detailid=00000000

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