Interface SchoolSearcherResponse

SchoolSearcherResponse は searchSchool API呼び出しに対するレスポンスを表します。

interface SchoolSearcherResponse {
    count: number;
    data: v20250101.School[];
    facets: v20250101.SchoolFacets | null;
    limit: number;
    offset: number;
    query: string;
    version: string;
}

Index

Properties

count data facets limit offset query version

Properties

count

count: number

合致した結果の総数。

data

data: v20250101.School[]

クエリに合致した学校の集合。

facets: v20250101.SchoolFacets | null

クエリに対する結果のファセット。

ファセットが指定されていない場合は利用できず、nullが格納されます。

limit

limit: number

取得しようとした最大件数。

offset

offset: number

結果を取得したオフセット値。

query

query: string

検索が実行されたクエリ。

version

version: string

データのバージョン。"YYYY-MM-DD" 形式。