Zum Hauptinhalt springen
GET
List Volume Reports

Autorisierungen

Authorization
string
header
erforderlich

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Abfrageparameter

periodYear
integer
Erforderlicher Bereich: 2000 <= x <= 2100
market
string

ISO alpha-2 (case-insensitive).

Pattern: ^[A-Z]{2}$
status
enum<string>

Exactly one report per (periodYear, market, format) is generated — that is the one to download.

Verfügbare Optionen:
generated,
superseded
limit
integer
Standard:100

Maximum number of results to return (default 100, max 1000).

Erforderlicher Bereich: 1 <= x <= 1000
offset
integer | null
Standard:0

Number of results to skip for pagination.

Erforderlicher Bereich: x >= 0
fields
string

Comma-separated list of the resource's top-level keys to return (per element for a list), e.g. id,name; omit for the full body. Top-level only; whitespace is trimmed and duplicates count once. fields never adds keys: a selected optional key that is absent on a row stays absent. 400 when passed more than once, when empty, or when it names an unknown key (the error names it and lists the allowed ones).

Antwort

Reports, newest first

id
string
erforderlich

UUID of the report — what GET /api/v1/ppwr/mengenmeldung/{reportId}/xml takes.

periodYear
number
erforderlich

Calendar year the report covers.

market
string
erforderlich

ISO alpha-2 market code.

format
string
erforderlich

One of: lucid_de, austria_edm, verpact_nl, ara_at, bdo_pl, miteco_es, conai_it.

reportType
string
erforderlich

The LUCID Meldungsart for lucid_de; worksheet registers always report ANNUAL. One of: HPM1, HMM1, HJM1, HNM1, HAM1, ANNUAL.

systemOperatorId
string
erforderlich

The dual system's LUCID number the volumes are reported under. Empty string for worksheet registers, which have no system operator.

xsdVersion
string
erforderlich

The LUCID XML interface version the file was built against; worksheet-<n> for worksheet registers, which have no XSD.

status
string
erforderlich

generated | superseded

version
number
erforderlich

Version of the report within its (periodYear, market, format) scope; each regeneration increments it.

supersedesId
string | null
erforderlich

The report this one replaced, or null.

snapshotHash
string
erforderlich

SHA-256 of the frozen snapshot.

generatedAt
string
erforderlich

When the report was generated (ISO 8601, UTC).