Klassendiagramme

Zur Veranschaulichung verschiedener Szenarien sind hier einige Klassendiagramme abgebildet. Diese entsprechen den Rückgabetypen der API.
Die zugrundeliegende SQL-Datenbank entspricht in etwa dieser Struktur, ist letztlich aber für die Benutzung der API weniger relevant.

Ein Gesamtüberblick über fast alle wichtigen Klassen unterhalb des zentralen Zeitraumelementes findet sich in dem separaten Abschnitt zu den Zeiträumen und wird hier nicht extra nochmal aufgeführt.

Generelle Beziehung Sender und Vermarkter

Jeder Sender und jeder Vermarkter hat eine eigene, nicht veränderbare Id. Hierbei handelt es sich um numerische Werte.
Für Sender (häufig auch als "Angebot" bezeichnet) werden derzeit Zahlen zwischen 800000 und 899999 vergeben, für Vermarkter ist der Nummernkreis 600000 bis 699999 vorgesehen.

Die Zuordnung zwischen Sender und Vermarkter wird über die Klasse "Zeitraum" hergestellt. Hierin sind dann die zeitliche Gültigkeit der Zuordnung wie auch Angaben z. Bsp. nationale / regionale Vermarktung EDI-Nummer usw. abgebildet.

Sämtliche vermarkterspezifischen werbeform- / preisrelevanten Informationen werden unterhalb dieser Zuordnung hinterlegt.

In den über die API ausgegebenen Objekten / Klassen werden häufig die in der zugrundeliegenden SQL-Datenbank in normalisierter Form vorliegenden Daten in aufgelöster Darstellung ausgegeben. Obwohl sich die originale Zuordnung anhand des Namens und über die jeweiligen Typenbereiche bei den allgmeinen Typen i.d.R. ableiten lassen, werden hier für das bessere Verständniss einige dieser Beziehungen als grafische Darstellung aufgeführt.

Zur Vereinfachung kann über den Endpunkt ../v1.1/Sender/{id}/{jahr}?datenFormat=1 ein mit allen aufgelösten Schlüsseln / Typen denormalisiertes Sender-Objekt bezogen werden.

Das Sender-Objekt im Detail

Die Werbeformen und zugehörigen Preise im Detail: