premium
ac_premium
住所クレンジング(高機能)
住所の正規化処理を行い、座標情報結果を返します。
漢字間違いや一部欠損の補完、表記ゆれの入力を吸収して対応します。
(住所クレンジングのロジックについて)
パラメータ指定により過去住所、地番での検索ができます。このとき、レスポンスは最も詳細な住所としてマッチしたものが返却されます。
最も詳細な住所が同レベルで複数存在する場合、それらのうち「住所」「過去住所」「地番」の順のレスポンスの優先度でより優先度の高いレスポンスを返却します。
テナント名称、部屋名称でのテナント検索、
建物名称、建物の最上階数での建物検索ができます。
また、成功した検索について、テナントの階数を含め、指定されたパラメータについて検索結果と一致しているかどうかを返却します。
なお、検索の順序は次の通りとなり、ヒットした場合、それ以外のパラメータの情報はマッチング情報として返却されます。
tenant_name→tenant_room_name→building_name→building_top_floor_num
例えば、tenant_nameでヒットせず、tenant_room_nameでヒットした場合で、building_nameおよびbuilding_top_floor_numが指定されている場合はbuilding_nameはbuilding_name_match、building_top_floor_numはbuilding_top_floor_num_matchの値にのみ影響があります。
※本APIを利用するには別途契約が必要です。
HTTP request method
POST/GET
ContentType
application/x-www-form-urlencoded
Parameters
*requiredは必須
Array型のパラメータの区切り文字は特記のない限りカンマ(,)およびセミコロン(;)です。
| 名前 | 説明 |
|---|---|
| word*required array[string] |
住所名称を指定 最大件数 100件。 1件当たりの最大文字数 255文字。 1文字以下の場合、マッチングレベルはNOMを返却します。 先頭から100文字までの文字列で検索します。 |
| enc integer default 0 |
入力住所の文字コードを指定
|
| building_name array[string] |
建物名称を指定 カンマ区切りで複数件の指定が可能です。 wordと同数指定する必要があります。(指定が無い場合、空文字とします) 最大100件。1件当たりの最大文字数 255文字。 |
| tenant_name array[string] |
テナント・入居者の名称を指定 カンマ区切りで複数件の指定が可能です。 wordと同数指定する必要があります。(指定が無い場合、空文字とします) 最大100件。1件当たりの最大文字数 255文字。 |
| tenant_room_name array[string] |
テナント・入居者の部屋名称を指定 カンマ区切りで複数件の指定が可能です。 wordと同数指定する必要があります。(指定が無い場合、空文字とします) 最大100件。1件当たりの最大文字数 255文字。 |
| building_top_floor_num array[integer] |
建物の最上階数を指定 カンマ区切りで複数件の指定が可能です。 wordと同数指定する必要があります。(指定が無い場合、空文字とします) 最大100件。 |
| tenant_floor array[string] |
※tenant_nameまたはtenant_room_nameが指定されている場合のみ有効。 テナント・入居者の階数を指定 カンマ区切りで複数件の指定が可能です。 wordと同数指定する必要があります。(指定が無い場合、空文字とします) 最大100件。1件当たりの最大文字数 255文字。 |
| match_level string default TBN |
マッチングする下限階層を指定 指定値より粗いmatch_levelのみが返却されます。 (例:match_levelがOAZ指定されている場合、返却されるmatch_levelはTOD,SHK,OAZのいずれかとなります。)
|
| use_multi_addr boolean default false |
重複住所出力機能の使用 falseの場合、複合マッチングも行われません。 (building_name,tenant_name,tenant_room_name,building_top_floor_num,tenant_floorの各パラメータが指定されていても無視されます。また、building_infoの各情報は返却されません。)
|
| use_kana boolean default false |
カナ住所マッチング機能の使用 trueの場合、通常の住所に加えてwordで指定した文字列がカナ住所と一致するかを検索します。他のパラメータは過去の値を検索しません。
|
| use_pastmap boolean default false |
過去住所 -> 現在住所変換機能の使用 trueの場合、通常の住所に加えてwordで指定した文字列が過去の住所と一致するかを検索します。 他のパラメータは過去の値を検索しません。
|
| use_bluemap boolean default false |
地番 -> 住所変換機能の使用 trueの場合、通常の住所に加えてwordで指定した文字列が地番と一致するかを検索します。
|
| datum string default JGD |
入出力座標の測地系を指定 JGD
世界測地系
TOKYO
日本測地系
TOKYO_NAVI
日本測地系(ゼンリン ナビ地図)
|
Responses
エラーについては「エラーメッセージ一覧」を参照してください。
Media type:application/json
| キー名 | 説明 | |||
|---|---|---|---|---|
|
|
ステータス | |||
|
|
|
hit integer |
処理件数。入力住所数と同じ。 | |
|
|
input_word string |
入力文字列 | ||
| address_code string |
住所コード | |||
| address string |
住所 | |||
| address_read_through string |
住所読み下し | |||
| address2 string |
都道府県名称 | |||
| address_read_through2 string |
都道府県名称読み下し | |||
| address3 string |
市区町村名称 | |||
| address_read_through3 string |
市区町村名称読み下し | |||
| address4 string |
大字名称 | |||
| address_read_through4 string |
大字名称読み下し | |||
| address5 string |
字丁目名称 | |||
| address_read_through5 string |
字丁目名称読み下し | |||
| address_detail1 string |
街区名称 | |||
| address_detail_read_through1 string |
街区名称読み下し | |||
| address_detail2 string |
地番戸番名称 | |||
| address_detail_read_through2 string |
地番戸番名称読み下し | |||
| post_code string |
郵便番号 | |||
| address_name_type integer |
住所階層が国～字丁目の住所に対し、住所名称の種類を表します。
|
|||
| child_level_flag integer |
子階層フラグ
|
|||
| match_level string |
マッチングレベル 入力住所・建物属性等に対してどこまでマッチしたかを示します。 過去住所・地番にマッチした場合、マッチした過去住所・地番からの逆引き結果が格納されますので、use_pastmapをtrueにした場合はpast_match_level、use_bluemapをtrueにした場合はbluemap_match_levelをそれぞれ合わせて確認するようにしてください。
|
|||
| match_flag integer |
入力住所(word)の全ての文字が出力住所(address)の中に含まれているかどうかを表すフラグ(正規化して判定)
|
|||
| match_position array[number] |
マッチング座標 建物座標があれば建物座標、なければ住所座標が返却されます。 ["経度","緯度"] |
|||
| match_kana string |
マッチングしたカナ住所文字列。カナ住所でマッチングした場合のみ返却します。 | |||
| match_pastmap string |
マッチングした過去住所文字列。過去住所でマッチングした場合のみ返却します。 | |||
| pastmap_year integer |
過去住所の年度を返却。過去住所でマッチングした場合のみ返却します。 | |||
| pastmap_position array[number] |
過去住所のマッチング座標。過去住所でマッチングした場合のみ返却します。 ["経度","緯度"] |
|||
| pastmap_child_level_flag integer |
過去住所の子階層フラグ。過去住所でマッチングした場合のみ返却します。
|
|||
| pastmap_match_level string |
過去住所のマッチングレベル。過去住所でマッチングした場合のみ返却します。
|
|||
| match_bluemap string |
マッチングした地番文字列。地番でマッチングした場合のみ返却します。 | |||
| bluemap_position array[number] |
地番のマッチング座標。地番でマッチングした場合のみ返却します。 | |||
| bluemap_child_level_flag number |
地番の子階層フラグ。地番でマッチングした場合のみ返却します。
|
|||
| bluemap_match_level string |
地番のマッチングレベル。地番でマッチングした場合のみ返却します。
|
|||
| multi_addr_count integer |
重複住所件数 | |||
| building_info object |
building_name string |
建物名称 | ||
| building_type integer |
建物・テナント等を判別する区分
|
|||
| building_name_match integer |
建物名マッチング情報 入力がない場合はnull
|
|||
| building_use string |
建物用途 | |||
| building_use_level string |
建物用途の推定情報
|
|||
| tenant_name string |
テナント・入居者名称 入居者については、マッチング情報を返却しますが、入居者情報については個人情報の取り扱いの観点から返却されません。 |
|||
| tenant_name_match integer |
テナント・入居者名称マッチング情報 入力がない場合はnull
|
|||
| tenant_room_name string |
テナント・入居者の部屋名称 | |||
| tenant_room_name_match integer |
テナント・入居者の部屋名称マッチング情報 入力がない場合はnull
|
|||
| building_top_floor_num integer |
建物の最上階数 | |||
| building_top_floor_num_match integer |
建物の最上階数マッチング情報 入力がない場合はnull
|
|||
| tenant_floor string |
テナント・入居者の階数 | |||
| tenant_floor_match integer |
テナント・入居者の階数マッチング情報 入力がない場合はnull
|
|||
| zid string |
建物ZID 建物等の地物毎にふられるパーマネントのID |
|||
| zid_attr string |
属性ZID 建物や地物内のテナント施設・入居者といった属性情報毎にふられるパーマネントのID |
|||
| position array[number] |
["経度","緯度"] | |||
Example
https://[domain]/data-coding/ac_premium?word=%E7%A6%8F%E5%B2%A1%E7%9C%8C%E9%82%A3%E7%8F%82%E5%B7%9D%E7%94%BA%E5%A4%A7%E5%AD%97%E7%89%87%E7%B8%84%C3%97%C3%97%C3%97%E7%95%AA%E5%9C%B0%C3%97&use_multi_addr=true&use_kana=true&use_pastmap=true&use_bluemap=true&datum=JGD
{
"status": "OK",
"result": {
"info": {
"hit": 1
},
"item": [
{
"input_word": "福岡県那珂川町大字片縄×××番地×",
"address_code": "40231011",
"address": "福岡県那珂川市大字片縄",
"address_read_through": "フクオカケンナカガワシオオアザカタナワ",
"address2": "福岡県",
"address_read_through2": "フクオカケン",
"address3": "那珂川市",
"address_read_through3": "ナカガワシ",
"address4": "大字片縄",
"address_read_through4": "オオアザカタナワ",
"address5": null,
"address_read_through5": null,
"address_detail1": null,
"address_detail_read_through1": null,
"address_detail2": null,
"address_detail_read_through2": null,
"post_code": "811-1201",
"address_name_type": 1,
"child_level_flag": 1,
"match_level": "OAZ",
"match_flag": 0,
"match_position": [
130.410182291667,
33.5146926540799
],
"match_kana": null,
"match_pastmap": "福岡県筑紫郡那珂川町大字片縄",
"pastmap_year": 2017,
"match_bluemap": null,
"multi_addr_count": null,
"building_info": [
{
"building_name": "xxx",
"building_name_match": null,
"building_type": 3,
"tenant_name": null,
"tenant_name_match": null,
"building_use": null,
"building_use_level": null,
"tenant_room_name": null,
"tenant_room_name_match": null,
"building_top_floor_num": null,
"building_top_floor_num_match": null,
"tenant_floor": null,
"tenant_floor_match": null,
"zid": "xxxxxxxxxxxxxxxxxx",
"zid_attr": "xxxxxxxxxxxxxxxxxx",
"position": [
130.xxxxxxxxxx,
33.xxxxxxxxxx
]
}
]
}
]
}
}