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

    Interface PublicBodyListParams

    Filters for GET /api/v1/publicbody/ (public bodies).

    interface PublicBodyListParams {
        category?: Id | Id[];
        classification?: Id;
        classification_id?: Id;
        jurisdiction?: Id;
        limit?: number;
        lnglat?: string;
        offset?: number;
        q?: string;
        regions?: IdList;
        slug?: string;
    }

    Hierarchy (View Summary)

    Index
    category? classification? classification_id? jurisdiction? limit? lnglat? offset? q? regions? slug?
    category?: Id | Id[]

    Category id(s): several are sent as repeated keys, which the API ORs.

    classification?: Id
    classification_id?: Id
    jurisdiction?: Id
    limit?: number

    Page size: an integer from 1 to MAX_PAGE_SIZE (50); defaults server-side to 50.

    lnglat?: string

    lng,lat point: keeps bodies whose regions contain it. Results are not sorted by distance, and a body matching through several regions repeats.

    offset?: number

    Position in the whole result set: a non-negative integer.

    q?: string
    regions?: IdList

    One geo-region id (that region and its sub-regions) or a comma list "1,2" / [1, 2] (exactly those regions). Upstream, a single id that doesn't exist filters nothing, so the client looks each id up first and rejects an unknown one (FdsValidationError).

    slug?: string

    Settings
    Member Visibility

    On This Page
    Properties