@maschinenlesbar.org/abgeordnetenwatch-cli
    Preparing search index...

    Interface ListParams

    Parameters for a collection request. Checked before any request (see validateListParams); an invalid value rejects with AwValidationError.

    interface ListParams {
        filters?: Record<string, FilterValue>;
        rangeEnd?: number;
        rangeStart?: number;
        sortBy?: string;
        sortDirection?: "asc" | "desc";
    }
    Index
    filters?: Record<string, FilterValue>

    Field filters, sent as query parameters. Keys may use the bracket-operator form, e.g. { "year_of_birth[gt]": 1990, sex: "f" }. Pass a related entity's id directly, e.g. { politician: 184945 }. Checked before any request (see validateFilters): a blank key or value, a key that is not a field name with at most one operator, an operator outside FILTER_OPERATORS, a paging or sorting name (range_end, ...) and a plain key next to a bracket key on the same field reject with AwValidationError, because the API would silently drop the filter.

    rangeEnd?: number

    Page size — number of items to return. The API honours this up to 1000; a value above 1000 is ignored and it falls back to its default page size (100). A non-negative safe integer.

    rangeStart?: number

    0-based offset of the first item to return; a non-negative safe integer.

    sortBy?: string

    Field name to sort by (e.g. last_name, id); not blank. Alone, the API sorts descending.

    sortDirection?: "asc" | "desc"

    Sort order, asc or desc; only together with sortBy (the API rejects it alone).