郵便番号情報検索
API名:
address/zipcodelist
概要:
リクエストパラメータで指定される郵便番号を元に前方一致で検索し、該当する郵便番号データを返却します。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelist
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=111
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 |
|---|---|---|---|
| zipcode | ○ | - |
郵便番号 郵便番号を指定します。 指定した郵便番号を元に前方一致で検索します。 本項目は必須項目であるため、未指定の場合はエラーとなります。 |
| datum | TOKYO |
測地系 返却される住所代表点の測地系を指定します。 |
|
| limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
出力データ
出力フォーマット
| キー名 | データ型 | 説明 | |
|---|---|---|---|
| status | object | ステータス情報が入ります。 | |
| info | object | 検索結果の情報が入ります。 | |
| hit | number | 入力された条件に対してヒットした件数が入ります。 | |
| item | array | 検索結果の配列が入ります。検索結果が0件の場合は空の配列となります。 | |
| zipcode | number | 郵便番号(ハイフン無し)が入ります。 | |
| address | object |
検索結果の住所の配列が入ります。 ※ end及びboundsは常にnullになります。 |
|
出力例
[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=111
[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=000
"text":"OK"},
"info":{"hit":0},"item":[]}