機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

住所検索: 完全な住所レコードの取得

get

/api/v2/address/retrieve

住所の取得

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

このエンドポイントは、v2スタイルのアドレス・フィールドを使用して、特定のアドレス・レコードのすべての情報を取得します。 住所レコードはIDで定義する必要があります。 IDは、検索操作によって返されたものです(/v2/address/findエンドポイントなどを参照)。

コスト: この関数が成功すると、ユーザーは課金されます。つまり、返された住所レコードごとの使用量が課金されます。

入力: 以前に取得したIDの値を使用して、Idという問合せパラメータを定義します。 バッチ処理では、IDのリストをカンマで連結できます。

出力: JSON object(s)を含むJSON配列。 これらの各オブジェクトは、正常に取得された住所レコードを表します。 このレコードには、/v2/addresscleanエンドポイントにすでに定義されているものと同じ属性が含まれます。

「レスポンスの例」 [ { "AQI ": "A ", "AVC": "V44-I44-P3-100 ", } ]

リクエスト

問合せパラメータ

• Id(required): string

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

トップに戻る

レスポンス

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

• application/json; charset=UTF-8

200 レスポンス

成功

本文( )

ルート・スキーマ : スキーマ

タイプ: array

ソースを表示

• Array of: object OutputRecord

{
    "items":{
        "$ref":"#/components/schemas/OutputRecord"
    },
    "type":"array"
}

ネストされたスキーマ : OutputRecord

タイプ: object

ソースを表示

• address1: string
• address2: string
• address3: string
• address4: string
• addressid: string
• adminarea: string
• city: string
• country: string
• countrycode: string
• dependentlocality: string
• doubledependentlocality: string
• fulladdress: string
• geoaccuracycode: string
• geoaccuracycodedescription: string
• geodistance: number
• latitude: number
• longitude: number
• postalcode: string
• postalcodeprimary: string
• postalcodesecondary: string
• subadminarea: string
• verificationcode: string
• verificationcodedescription: string
• verified: string

{
    "properties":{
        "address1":{
            "type":"string"
        },
        "address2":{
            "type":"string"
        },
        "address3":{
            "type":"string"
        },
        "address4":{
            "type":"string"
        },
        "addressid":{
            "type":"string"
        },
        "adminarea":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "countrycode":{
            "type":"string"
        },
        "dependentlocality":{
            "type":"string"
        },
        "doubledependentlocality":{
            "type":"string"
        },
        "fulladdress":{
            "type":"string"
        },
        "geoaccuracycode":{
            "type":"string"
        },
        "geoaccuracycodedescription":{
            "type":"string"
        },
        "geodistance":{
            "type":"number"
        },
        "latitude":{
            "type":"number"
        },
        "longitude":{
            "type":"number"
        },
        "postalcode":{
            "type":"string"
        },
        "postalcodeprimary":{
            "type":"string"
        },
        "postalcodesecondary":{
            "type":"string"
        },
        "subadminarea":{
            "type":"string"
        },
        "verificationcode":{
            "type":"string"
        },
        "verificationcodedescription":{
            "type":"string"
        },
        "verified":{
            "type":"string"
        }
    },
    "type":"object"
}

401 レスポンス

承認されていません

403 レスポンス

禁止

500 レスポンス

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

「トップに戻る」