住所内判定

/address_inclusion [GET]

緯度経度が住所コードの範囲内に含まれているかを判定します。

https://{HOST}/{CID}/v1/address_inclusion

※APIマーケットの場合はURL体系が異なります

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
code	✔	住所コード	文字列			住所コードは丁目・小字レベル（11桁）まで指定可能ですピリオド区切りで複数指定可能です
coord	✔	緯度経度	カンマ区切りの数値(緯度, 経度)
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系

/address_inclusion?code=13&coord=35.664159,139.718117

名称	レスポンス名	型名	配列	Nullable	説明
判定結果	items	AddressInclusionオブジェクト	〇

名称	レスポンス名	型名	配列	Nullable	説明
緯度経度が住所内に含まれるか	included	真偽値

codeを複数指定した場合

codeをピリオド区切りで複数指定した場合は「OR検索」となります。
指定した住所コードのうち、どれか一つでもcoordで指定した緯度経度を含んでいればtrueと判定されます。

{
    "items": [
        {
            "included": true
        }
    ]
}

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: code: ['required field']	必須パラメータである code が指定されていない場合に発生します。
400	parameter error: code: ['empty values not allowed']	code が空文字で指定された場合に発生します。
400	parameter error: code: ['an invalid code: {value}']	code にピリオド区切りで不正な住所コードを指定した場合に発生します（各コードは英数字のみで桁数が 2, 5, 8, 11 のいずれかである必要があります。11桁超のコードはエラーとなります）。
400	parameter error: coord: ['required field']	必須パラメータである coord が指定されていない場合に発生します。
400	parameter error: coord: ['empty values not allowed']	coord が空文字で指定された場合に発生します。
400	parameter error: coord: ['an invalid coordinate : {value}']	coord に不正な座標形式の値を指定した場合に発生します。
400	parameter error: datum: ['unallowed value {value}']	datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。