Interface SchoolSearcherResponse

A SchoolSearcherResponse describes a response to searchSchool API call.

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

Properties

count: number

The number of the resulting items in total.

The set of the schools that match to the query.

The facets of the result that form with the query.

If no facet is given, those will be unavailable and this stores null.

limit: number

The number of items that have been intended, at most, to retrieve.

offset: number

The offset from which the result has been retrieved.

query: string

The query that the search has been performed for.

version: string

The version of the data, in the form of "YYYY-MM-DD".