住所検証
/api/v3/address/verify
住所検証: このエンドポイントは、アドレスを検証する手段を提供します。つまり、入力アドレス・レコードに指定されたアドレスが有効かどうかを確認します。 有効な場合は、クレンジング/訂正された住所を出力レコードとして返します。
このPOSTの「入力」は、inputs[]というアドレス・レコードのリストを含む最上位のJSONオブジェクトです。 各住所レコードは、フィールドのJSONマップです。 すべてのフィールド値は文字列として表されます。 最上位オブジェクトにオプションと呼ばれるJSONマップを追加することで、結果をさらにカスタマイズできます。 オプションはプロセスに影響を与えます。 次に例を示します: OutputScript=Latn, PreferPrimaryValidAlias=Yes, DisableEnhance=No. 有効なオプション・パラメータの詳細
「出力」は、Statusフィールドとoutputs[]という出力アドレス・レコードのリストを含むJSONオブジェクトです。 各アドレス・レコードはフィールドのJSONマップであり、すべてのフィールド値は文字列として表されます。 outputs配列は、入力配列に対応します。 つまり、レコード出力[n]はレコード入力[n]に対するレスポンスです。
出力には「ステータス」フィールドが含まれ、値「OK」はトランザクション全体を完了できることを意味します。 「ステータス」に「エラー」と表示されている場合は、「エラー」フィールドに理由が表示されます。
パラメータlqtkeyを送信する必要がないなどの若干の違いを除き、このエンドポイントは「住所検証」と非常によく似ています。
コスト: 出力住所レコードがまったく検証できない場合(AVCメイン・コードはUまたはR)、ユーザーはこのレコードに対して課金されます。
機能: 各入力レコードと各出力レコードはJSONマップであり、次の表でフィールドについて説明します。
| 属性名 | 方向 | 説明 |
|---|---|---|
AQI |
Out | 住所品質インデックスは、出力住所レコードの品質を示すために使用されます。
|
AVC |
Out | この住所の住所検証コード。 この文字列の最初の文字は、この特定のアドレスの結果に関する最も重要な情報を伝えます:
|
Address |
In/Out | 関連する国の郵送用に正しく書式設定された完全な住所。 異なる行はパイプ(|)文字で区切られます。 |
Address1 ... Address8 |
In/Out | これらのフィールドは、Addressパラメータと同じデータを表し、1行に分割したばかりです。 |
AdministrativeArea |
In/Out | 国内で最も一般的な地理データ要素。 たとえば、米国の州やカナダの州などです。 |
Country |
In | 国名、またはISO 3166 2または3文字の国略称のいずれか。 |
CountryName |
Out | ISO 3166正式名称。 |
DeliveryAddress |
In/Out | 完全な住所から組織、地域、AdministrativeArea階層およびPostalCode階層フィールドを差し引いたもので、パイプ文字(|)を使用して指定された改行など、関連する国の郵送用に正しく書式設定されています。 |
DeliveryAddress1 ... DeliveryAddress8 |
In/Out |
これらのフィールドは、DeliveryAddressパラメータと同じデータを表し、1行に分割したばかりです。 |
DependentLocality |
In/Out | Locality パラメータの内容に応じて、小さい母集団センター・データ要素。 例えば、トルコ近所。 |
DoubleDependentLocality |
In/Out | 最小の母集団センター・データ要素。LocalityパラメータとDependentLocalityパラメータの両方に依存します。 例えば、イギリスの村。 |
ISO3166-2 |
Out | ISO 3166 2文字の国コード |
IDO3166-3 |
Out | ISO 3166 3文字の国コード |
ISO3166-N |
Out | ISO 3166 3桁の数値の国コード |
Locality |
In/Out | 住所の納税地、町、または市。 |
PostalCode |
In/Out | 特定の搬送ポイントの完全な郵便番号は、その詳細を決定できる必要があります。 |
PostalCodePrimary |
Out | 特定の国に使用されるプライマリ郵便番号。 たとえば、USA ZIPです。 |
PostalCodeSecondary |
Out | セカンダリ郵便番号情報(特定の国で使用されている場合)。 たとえば、USA ZIP Plus 4です |
Premise |
In/Out | 個々の事業所を識別する英数字コードが存在している必要があります。 |
PremiseNumber |
In/Out | Premiseフィールド内の英数字インジケータが存在する必要があります。 たとえば、需要場所に「プロット7/7a」が含まれている場合、特定の国内に十分な解析レベルの詳細が存在する場合は、PremiseNumberに「7/7a」が含まれます。 |
SubAdministrativeArea |
In/Out | 国内で最も小さい地理データ要素(該当する場合)。 たとえば、米国の郡です。 |
SuperAdministrativeArea |
In/Out | 国内で最大の地理データ要素(該当する場合) |
Thoroughfare |
In/Out | 国内で最も一般的な通りまたはブロック・データ要素。 たとえば、USA Streetです。 |
次に、JSON検証リクエストの例を示します:
{ "inputs":[ { "Address1":"koniginstrasse 5", "Address2":"munich germany" } ] }次に、対応するJSONレスポンスを示します:
{ "Status": "OK", "outputs": [ { "AQI": "A", "AVC": "V44-I44-P3-100", "Address": "Kniginstr. 5|80539 Mnchen", "Address1": "Kniginstr. 5", "Address2": "80539 Mnchen", "AdministrativeArea": "Bayern", "CountryName": "Germany", "DeliveryAddress": "Kniginstr. 5", "DeliveryAddress1": "Kniginstr. 5", "DependentLocality": "Maxvorstadt", "ISO3166-2": "DE", "ISO3166-3": "DEU", "ISO3166-N": "276", "Locality": "Mnchen", "PostalCode": "80539", "PostalCodePrimary": "80539", "Premise": "5", "PremiseNumber": "5", "SubAdministrativeArea": "Oberbayern", "Thoroughfare": "Kniginstr." } ], "Error": null } リクエスト
この操作にはリクエスト・パラメータがありません。
- application/json; charset=UTF-8
- application/json; charset=UTF-8
objectレスポンス
- application/json; charset=UTF-8