Interface AddressSearcherResponse

AddressSearcherResponse` は、"searchAddresses" API 呼び出しの結果を表現します。

interface AddressSearcherResponse {
    count: number;
    data: Address[];
    facets: null | v20221101.Facet[];
    limit: number;
    offset: number;
    query: v20221101.AddressSearcherQuery;
    version: string;
}

Hierarchy (View Summary)

AddressResolverResponse
- AddressSearcherResponse

Index

Properties

count data facets limit offset query version

Properties

count

count: number

検索結果となる項目の総数。

data

data: Address[]

問い合わせに合致する項目の集合。

facets

facets: null | v20221101.Facet[]

問い合わせによって形作られた、結果のファセット。

もしファセットが与えられていない場合はnullが入ります。

limit

limit: number

検索結果から取得しようとした項目の最大数。

offset

offset: number

取得した検索結果の開始オフセット。

query

query: v20221101.AddressSearcherQuery

検索が行われる対象となった問い合わせ。

version

version: string

データのバージョン。 "YYYY-MM-DD"形式で、 Y、M、Dはそれぞれソースとなったデータが利用可能になった日の年月日を表します。