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

    Interface ResponseEnvelope

    Common envelope fields shared by both endpoints. Every response carries the source / licence attribution and the data timestamp (updated) — the CLI passes these through because CC BY 4.0 requires displaying them (see DATA_LICENSE.md).

    interface ResponseEnvelope {
        apiVersion: string;
        bbox?: number[];
        description: string;
        eTag?: string;
        lang: string;
        lastModified?: string;
        legend?: Legend;
        licence: string;
        licenceName: string;
        source: string;
        sourceLogo?: string;
        sourceName: string;
        status: string;
        title: string;
        updated: string;
    }

    Hierarchy (View Summary)

    Index
    apiVersion bbox? description eTag? lang lastModified? legend? licence licenceName source sourceLogo? sourceName status title updated
    apiVersion: string
    bbox?: number[]

    [west, north, east, south] per the live API (not the RFC 7946 order), a fixed box around Germany whatever the states filter.

    description: string
    eTag?: string
    lang: string
    lastModified?: string
    legend?: Legend
    licence: string
    licenceName: string
    source: string
    sourceLogo?: string
    sourceName: string
    status: string
    title: string
    updated: string

    Data timestamp — display this when presenting the data (CC BY 4.0).

    Settings
    Member Visibility

    On This Page
    Properties