type

Series

A statutory calculation value tracked over time — for example the reference value of German social insurance — together with the metadata that describes it.

A series can consist of several values that belong together and always change together. The reference value is published as an annual and a monthly amount, and both are parts of one series, each identified by its own key and carrying its own unit. The values themselves are held by the data points of the series and are read via the dataPoint query, which returns all parts of a series at once.

A series is the addressable unit of the catalog: it is what id names and what the series and dataPoint queries are asked about.

Felder

id: ID!: The stable, dot-separated path that identifies the series within the catalog, for example de.sv.allgemein.bezugsgroesse.

The segments run from the broadest to the narrowest classification — country, area of law, further subdivisions and finally the calculation value itself. The period a value refers to is not a segment of the id: annual and monthly amounts of the same calculation value are parts of one series and are told apart by the key of their DataPointValue.

The id is stable across releases and is the key used by the series and dataPoint queries.
name: String!: The name of the calculation value, suitable for display, for example Bezugsgröße.

The name covers the series as a whole; it does not name an individual value part, so it carries no hint of period or unit.

Provided in the language of the catalog entry, which for the current catalog is German.
description: String!: A short explanation, one or two sentences long, aimed at a reader who may not know this calculation value.

Provided in the language of the catalog entry, which for the current catalog is German.
valueParts: [SeriesValuePart!]!: The value parts of the series: one entry per value that each data point of the series carries, so for the reference value of German social insurance one entry for the annual and one for the monthly amount.

The keys are the same keys under which DataPoint.values delivers the values, and each entry states the unit those values are given in. Join the two by key.

The order is the order of the catalog entry and not a guaranteed part of the contract — address a value part by its key, never by its position.
coveredFrom: LocalDate: The earliest validity date covered by this series: the catalog claims no knowledge about how the value stood before this date.

A dataPoint query with a validOn before this date therefore returns null. null here means the lower bound of the coverage is not stated.
coveredTo: LocalDate: The latest validity date covered by this series.

null — the usual case — means the series has no end date. A date is given for calculation values that have expired, and it marks the last date for which the catalog provides a value.