機械翻訳について
  1. Oracle Address, Email, and Phone Verification向けREST API
  2. タスク
  3. Version2

住所の検索および検証

post

/api/v2/addressclean

住所クリーン

ノート: 最新バージョンv3/で同等の機能を使用することをお薦めします。

このメソッドでは、1つ以上の住所入力レコードがクレンジングされる必要があります。 成功すると、出力レコードが送り返されます。

この入力は、少なくとも1つのレコード要素を含むJSON配列として送信する必要があります。 入力はコンテンツとして送信する必要があります。'application-json'と入力します。 各レコード要素にはすべての必須属性が設定されている必要があり、JSONマップとして書式設定する必要があります。

各入力レコードと各出力レコードはJSONマップであり、次の表でパラメータについて説明します。 各パラメータ(入力または出力)は、この特定のレコードのモードにパラメータを適用できない場合でも、JSONマップに含めることができます。 この場合、パラメータは無視されます。 詳細は、「エンタープライズ・データ品質のアドレス・クリーン・インタフェース11.1.1.7.9」を参照してください。
属性名 データ型 方向 適用可能なモード ノート
addressid 文字列 In/Out V,S 入力レコードを出力レコードにマップする識別子(またはその逆)。
address1 文字列 In/Out V,S 住所行1

SEARCHモードの場合: Oracleでは、既知のすべての情報(国を除く)をテキストとしてこのフィールドに指定することをお勧めします。 countryまたはdefaultcountrycodeフィールドは、国が既知の場合にのみ使用します。

address2 文字列 In/Out V,S 住所行2
address3 文字列 In/Out V,S 住所行3
address4 文字列 In/Out V,S 住所行4
dependentlocality 文字列 In/Out V,S cityフィールドの内容に応じて、母集団センターのデータ要素が小さくなります。 例えば、トルコの近隣。 多くの国では、この属性は使用されません。
doubledependentlocality 文字列 In/Out V,S 最小の母集団センター・データ要素。cityフィールドとdependentlocalityフィールドの両方のコンテンツに依存します。 例えば、イギリスの村。 多くの国では、この属性は使用されません。
city 文字列 In/Out V,S 住所の納税地、町、または市。
subadminarea 文字列 In/Out V,S 国内で最小の地理データ要素。 たとえば、米国の郡です。
adminarea 文字列 In/Out V,S 国内で最も一般的な地理データ要素。 たとえば、米国の州やカナダの州などです。
postalcode 文字列 In/Out V,S 住所の郵便番号(国に関連する場合)。
postalcodeprimary 文字列 In/Out V,S 郵便番号の最初の部分。
postalcodesecondary 文字列 In/Out V,S 郵便番号の2番目の部分(国に関連する場合)。
country 文字列 In/Out V,S 入力時に、ISO 2文字の国コード(優先)または国名。 出力時に、完全な国名(入力が国のISOコードの場合でも)。

ノート: このフィールドが空白の場合は、国を導出するために他のフィールドを内部で使用できます。 検証モードでは国が必要です。 countryフィールドとdefaultcountrycodeフィールドの両方が空白の場合、米国は国として割り当てられます。

defaultcountrycode 文字列 入力のみ V,S 国コードが空白の場合に使用するデフォルトのISO 2文字の国コード。 これにより、デフォルトの国値が上書きされます。
outputscript (parameter) 文字列 入力のみ V,S (address1..n、管理領域、市区町村など)特定の入力および出力ファイルは、異なるスクリプトで送受信できます。 (国以外) - または郵便番号関連のフィールドの場合、これらはラテン語(英語)である必要があります
入力として、ネイティブ・スクリプトと、異なる場合はLatn (英語)が適切に機能することが期待されます。 このパラメータ(オプション)を使用して、ISO 15924コード(Latn (i.e. English), Cyrl, Grek, Hebr, Hani, Hans, Arab, Thai, Hang, Native>. など)を介して特定のスクリプトを返すようにリクエストできます ネイティブはコードではなく、特定の国のローカル・スクリプトを選択する提案です。 "ネイティブ"および"ラテン"を使用するリクエストは、いつでも実行できます。 このパラメータが指定されていないか、値が空の場合は、transliterateをオフにするオプションをオンにします。これがデフォルトの動作です。 つまり、出力スクリプトは、使用される入力スクリプトに基づいて選択されます(つまり、入力がネイティブ・スクリプトで提供され、このネイティブ・スクリプトをサポートしている場合、出力は同じネイティブ・スクリプト内に存在します)。 その他のすべての場合、出力スクリプトはLatn (英語)に設定されます
charcase (parameter) 文字列 入力のみ V,S 設定に従って出力を変換します:

U (Upper) - すべてのテキストを大文字に変換します。

L (Lower) - すべてのテキストを小文字に変換します。

M (Mixed) - postalcodeおよびadminareaを除くすべてのテキストを大/小文字混在に変換します。 これらのフィールド値は、アドレスが検証された場合にAVプロセッサから返されたままになります。 アドレスが検証されなかった場合、postalcodeは入力されたままになり、adminareaは大/小文字混在に変換されます。

O (Original) - テキストは変換されません。

mode (parameter) 文字列 入力のみ V,S リクエストを実行するモード。

このレコードを確認するにはVと入力し、このレコードを検索するにはSと入力します。 Version2 APIでは、追加された検索の様々な方法がサポートされるようになりました。 このモードを「S」に設定すると、そのいずれかになります。 (別の方法については、findおよびpreparefindも参照してください)検索モードでは、入力レコードごとに最大20個の出力レコードを取得できることに注意してください。 これらのレコードは、最良の潜在的検索結果から最悪の順でソートされます。

minimumverificationmatchscore (parameter) 数値 入力のみ V,S 0から100までの数値で、クレンジングされた住所として使用するために一致で達成する必要がある最小スコアを表します。 住所の検証プロセッサの照合スコアが入力パラメータより低い場合、入力住所は変更されません。 オプション。デフォルトは0です
minimumverificationlevel (parameter) 数値 入力のみ V,S 1から5までの数値で、消去された住所として使用するために一致で達成する必要がある最小検証レベルを表します。 オプション。デフォルトは1です。

住所の検証プロセッサの検証レベルが入力パラメータより低い場合、入力住所は変更されません。 各レベルの説明については、「セクション2.1.3、「検証レベルのノート」」を参照してください。

allowedverificationresultcodes (parameter) 文字列 入力のみ S 次の1文字の結果コードのうち、区切り文字を含まないもののリスト。 オプション。検証モードのデフォルト文字列はVPで、検索モードはVPARです。

V (Verified)

P (一部検証済)

A (Ambiguous)

R (Reverted)

U (未検証、入力としてリクエストできません)

アドレスの検証結果コード(たとえば、verificationcodeの最初の文字)が、リストされた入力値のいずれでもない場合、入力アドレスは変更されません。

fulladdress 文字列 出力のみ V,S 住所検証から完全な検証済住所が返されました。 住所行はパイプで区切られます。
countrycode 文字列 出力のみ V,S 検証済住所国のISO 2文字の国コードです。
verificationcode 文字列 出力のみ V,S 住所の検証コード。 詳細は、「アドレス検証プロセッサ」ページ」のAccuracyCodeタブAccuracyCodeの検証コード化説明フィールドを参照してください。
verified 文字列 出力のみ V,S 検証モード: 生成された結果がプロセスの構成および結果の検証コードに従って十分なレベルまで検証されたかどうか。 また、入力住所が住所検証から返された住所に変更されたかどうかも示します。

検索モード: この入力に対して少なくとも1つ以上の結果が見つかりました。 戻り値: Y Yesが正常に実行されたか、N Noが成功しなかったか、X EDQ AVが正しく構成されていません。

verificationcodedescription 文字列 出力のみ V,S 確認コードの英語の説明。

指定した国(暗黙的または明示的に)は、検証モードで特別なステータスになります。 また、検証モードでは、全体的なステータスがUNVERIFIED / verified=Nで、一致スコアが100である結果を取得できます。 この場合、UNVERIFIEDステータスはスコアよりも優先されます。

latitude 数値 出力のみ V この属性はサポートされていません。
longitude 数値 出力のみ V この属性はサポートされていません。
geoaccuracycode 文字列 出力のみ V この属性はサポートされていません。
geoaccuracycodedescription 文字列 出力のみ V この属性はサポートされていません。
geodistance 数値 出力のみ V この属性はサポートされていません。

リクエスト

問合せパラメータ
サポートされるメディア・タイプ
リクエスト本文 - application/json; charset=UTF-8 ()
ルート・スキーマ : スキーマ
タイプ: array
ソースを表示
ネストされたスキーマ : InputRecord
タイプ: object
ソースを表示
トップに戻る

レスポンス

サポートされるメディア・タイプ

200 レスポンス

成功
本文( )
ルート・スキーマ : スキーマ
タイプ: array
ソースを表示
ネストされたスキーマ : OutputRecord
タイプ: object
ソースを表示

401 レスポンス

承認されていません

403 レスポンス

禁止

500 レスポンス

リクエスト中に予期しないエラーが発生しました。
トップに戻る

例

リクエストの例

[{"addressid":"a225-65f8b7f90b18","address1":"500 Oracle Parkway","city":"Redwood City","defaultcountrycode":"US","charcase":"M","mode":"V"}]

次の例は、コマンドライン・ツールcurlを使用したクライアント起動を示しています。 クイック・テストのために明細をコピー/ペーストします。
curl -i -H "Accept: application/json" -H "Content-Type: application/json" --basic --user myname:mypasswd -X POST -d "[{"addressid":"a225-65f8b7f90b18","address1":"500 Oracle Parkway","city":"Redwood City","defaultcountrycode" :"US","charcase":"M","mode":"V"}]" https://mydataservice-a18451.data.dc777.oraclecloud.com/av/api/v2/addressclean
「トップに戻る」