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

    Interface SearchParams

    Parameters for /sucheJson.

    interface SearchParams {
        allowUnknownFilters?: boolean;
        filters?: readonly SearchFilter[];
        page?: number;
        pageSize?: number;
        q?: string;
        sort?: string;
    }
    Index
    allowUnknownFilters? filters? page? pageSize? q? sort?
    allowUnknownFilters?: boolean

    Accept a filter attribute outside SEARCH_FILTER_ATTRIBUTES or a value outside SEARCH_FILTER_VALUES, e.g. one the register added after this release. Off by default. The reply must still echo the filter in searchParameters.facets.

    filters?: readonly SearchFilter[]

    Facet filters, sent as filter[<attribute>][<value>]=true — e.g. [{ attribute: "revolvingdoordata", value: "true" }]. Values of one attribute are alternatives; different attributes must all match. Each attribute must be one of SEARCH_FILTER_ATTRIBUTES and each value one of SEARCH_FILTER_VALUES (matched case-insensitively; a bare sub-code such as FOI_EU_LAWS is sent with its parent), else LobbyValidationError before any request.

    Optionalpage

    page?: number

    1-based page number (default 1). Needs pageSize. Applied by the client, not sent: the API ignores paging and returns every match.

    pageSize?: number

    Results per page, sliced client-side out of the full result set.

    q?: string

    Free-text query string. Omit it to match the whole register; a blank value ("" or whitespace) rejects with LobbyValidationError.

    sort?: string

    Sort order, e.g. "RELEVANCE_DESC", "REGISTRATION_DESC". Must not be blank.

    Settings
    Member Visibility

    On This Page
    Properties