Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AddressSearcherResponse

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

Hierarchy

Index

Properties

count: number

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

data: Address[]

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

facets: null | Facet[]

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

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

limit: number

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

offset: number

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

query: AddressSearcherQuery

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

version: string

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

Generated using TypeDoc