Oracle Address, Email, and Phone Verification向けREST API

住所検索: 間接モードでの住所の検索

get

/api/v3/address/find

住所検索

このエンドポイントは、間接モードでのテキストベースの検索を実装します。 (検索を高速化するには、 /preparefind.)で直接モードを使用住所検索では、住所レコードまたは特定の住所コンポーネント(番地、市区町村、郵便番号など)の先行入力検索が提供されます。

原価: このアクションは通常、使用件数のコストまたは増加は発生しません。

次のステップでは、結果を目的のレコードに絞り込み、/v3/address/retrieveエンドポイントを使用してそれを完全に取得します。

入力として、ユーザーがこれまでに入力した値を使用して、Textという問合せパラメータを少なくとも1つ定義します。これは唯一の必須入力パラメータです。
検索を絞り込むための追加パラメータ:
コンテナ : 文字列値は、オブジェクトから以前に取得したIDである必要があります。
オリジン: 文字列値ベースは、ロケーションから検索結果を検索します(デフォルトはパブリックIPアドレスです)。
最大限度: 返される結果の数(デフォルトは7)。
言語: この結果の優先言語。

出力は、JSONオブジェクトのJSONリストです。各オブジェクトは、次の属性を持つ潜在的な検索結果を表します

属性名	説明
`Id`	この検索結果を識別する文字列値。この値は、`/v3/address/retrieve`エンドポイントを介してこのオブジェクトを取得するために使用できます
`Type`	この属性は、この検索結果が表すエンティティのソートを識別するのに役立ちます。値は次のとおりです: `Address, Street, City,` など。ドリル・ダウンが可能です。たとえば、住所を探しているときに、50件の一致が考えられる通りを取得したとします。通りでドリルダウンするには、同じ検索リクエストを再発行しますが、新しい問合せパラメータContainerとして指定されたIDを追加します。
`Text`	これは、この潜在的な結果をユーザーに説明する1行の文字列値です。
`Highlight`	これは、テキスト値内のsubstring(s)の表記です。元のテキスト入力に一致した箇所を強調表示するために使用されます
`Description`	この潜在的な結果に関連する追加情報を含む文字列値。

次のステップは、結果を絞り込むことです。詳細は、「ここは」を参照してください。

レスポンスの例

 [ {"Id":"US|US|B|Z222725132|941","Type":"Address","Text":"941 Terra California Dr","Highlight":"0-3","Description":"Walnut Creek CA 94595"}, {"Id":"US|US|ENG|94595-CA-WALNUT_CREEK--DR-TERRA_CALIFORNIA--941","Type":"BuildingNumber","Text":"941 Terra California Dr Apt","Highlight":"0-3","Description":"Walnut Creek CA 94595 - 3 Addresses"}, {"Id": "US|US|ENG|94579-CA-SAN_LEANDRO--BLVD-LEWELLING--941","Type":"BuildingNumber","Text":"941 Lewelling Blvd Apt","Highlight":"0-3","Description":"San Leandro CA 94579 - 36 Addresses"}, {"Id":"US|US|B|Z209400723|941","Type":"Address","Text":"941 Lewelling Blvd","Highlight":"0-3","Description":"San Leandro CA 94579"}, {"Id":"US|US|B|Z222676602|941","Type":"Address","Text":"941 Garcia Ave","Highlight":"0-3","Description":"Pittsburg CA 94565"}, {"Id":"US|US|B|Z222676603|941","Type":"Address","Text":"941 Garcia Ave Ste","Highlight":"0-3","Description":"Pittsburg CA 94565"}, {"Id":"US|US|B|Z222923677|941","Type":"Address","Text":"941 Clyde Ave","Highlight":"0-3","Description":"Santa Clara CA 95054"}, {"Id":"US|US|B|Z222923696|941","Type":"Address","Text":"941 Laurelwood Rd","Highlight":"0-3","Description":"Santa Clara CA 95054"}, {"Id":"US|US|ENG|94501-CA-ALAMEDA--CT-SHOREPOINT--941","Type":"BuildingNumber","Text":"941 Shorepoint Ct Apt","Highlight":"0-3","Description":"Alameda CA 94501 - 146 Addresses"}, {"Id":"US|US|B|Z213529633|941","Type":"Address","Text":"941 Shorepoint Ct","Highlight":"0-3","Description":"Alameda CA 94501"}] ]

リクエスト

問合せパラメータ

Text(required): string

ヘッダー・パラメータ

True-Client-IP(required):

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

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

application/json

200 レスポンス

成功

ルート・スキーマ : 配列

タイプ: array

タイトル: array

キーと値の配列

ソースを表示

Array of: object items

{
    "description":"array of key and values",
    "items":{
        "type":"object"
    },
    "title":"array",
    "type":"array"
}

ネストされたスキーマ : アイテム

タイプ: object

401 レスポンス

承認されていません

403 レスポンス

禁止

500 レスポンス

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

「トップに戻る」