Interface NTACorporateInfoSearcherResponse

NTACorporateInfoSearcherResponseはsearchNTACorporateInfo API 呼び出しの応答を記述します。

interface NTACorporateInfoSearcherResponse {
    count: number;
    data: v20250101.NTACorporateInfo[];
    facets: null | v20250101.NTACorporateInfoFacets;
    limit: number;
    offset: number;
    query: string;
    version: string;
}

Index

Properties

count data facets limit offset query version

Properties

count

count: number

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

data

data: v20250101.NTACorporateInfo[]

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

facets

facets: null | v20250101.NTACorporateInfoFacets

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

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

limit

limit: number

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

offset

offset: number

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

query

query: string

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

version

version: string

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