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

    Interface RequestListParams

    Filters for GET /api/v1/request/ (FOI requests).

    interface RequestListParams {
        campaign?: Id;
        categories?: string;
        checked?: boolean;
        classification?: string;
        costs_max?: number;
        costs_min?: number;
        created_at_after?: string;
        created_at_before?: string;
        follower?: Id;
        has_same?: boolean;
        is_foi?: boolean;
        jurisdiction?: Id;
        law?: Id;
        limit?: number;
        offset?: number;
        project?: Id;
        public_body?: Id;
        reference?: string;
        resolution?:
            | "successful"
            | "partially_successful"
            | "not_held"
            | "refused"
            | "user_withdrew_costs"
            | "user_withdrew";
        slug?: string;
        status?: | "awaiting_user_confirmation"
        | "publicbody_needed"
        | "awaiting_publicbody_confirmation"
        | "awaiting_response"
        | "awaiting_classification"
        | "asleep"
        | "resolved";
        tags?: string;
        user?: Id;
    }

    Hierarchy (View Summary)

    Index
    campaign? categories? checked? classification? costs_max? costs_min? created_at_after? created_at_before? follower? has_same? is_foi? jurisdiction? law? limit? offset? project? public_body? reference? resolution? slug? status? tags? user?
    campaign?: Id

    A campaign id, or "-" for requests that belong to no campaign.

    categories?: string

    The exact name of a category, case-sensitive ("Umwelt", as categories.list shows it) — not its id or slug, which match nothing. Matches requests whose public body is in that category.

    checked?: boolean
    classification?: string

    The exact name of a public-body classification, case-sensitive ("Ministerium") — not its id or slug, which match nothing.

    costs_max?: number

    Maximum charged costs in EUR: a finite non-negative number.

    costs_min?: number

    Minimum charged costs in EUR: a finite non-negative number.

    created_at_after?: string
    created_at_before?: string
    follower?: Id
    has_same?: boolean
    is_foi?: boolean
    jurisdiction?: Id
    law?: Id
    limit?: number

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

    offset?: number

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

    project?: Id

    Optionalpublic_body

    public_body?: Id
    reference?: string
    resolution?:
        | "successful"
        | "partially_successful"
        | "not_held"
        | "refused"
        | "user_withdrew_costs"
        | "user_withdrew"
    slug?: string
    status?:
        | "awaiting_user_confirmation"
        | "publicbody_needed"
        | "awaiting_publicbody_confirmation"
        | "awaiting_response"
        | "awaiting_classification"
        | "asleep"
        | "resolved"
    tags?: string

    One tag name, exact and case-sensitive (as requests.tagsAutocomplete returns it).

    user?: Id

    Settings
    Member Visibility

    On This Page
    Properties