Lesebereich Version 1.1

Allgemeines

Nach mittlerweile mehr als zwei Jahren Projektlaufzeit und diversen Änderungen in der Gesamtarchitektur und der Positionierung der API innerhalb dieser Architektur ergaben sich einige Anpassungen. Bisher nicht verwendete Eigenschaften ( z. Bsp. die redundante Sender-Kategorie ) bzw. Endpunkte wurden entfernt, einige kleinere Inkonsistenzen bei der Benennung von Objekteigenschaften wurden beseitigt.

Weil die Daten bisher nie als xml angefordert wurden, erfolgt die Ausgabe jetzt generell nur noch als Json.

Nachdem eine Beschränkung der auszugebenden Sender pro anfragenden Klienten eingeführt wurde ( dies war im ursprünglichen Architekturentwurf nicht vorgesehen, weil alle veröffentlichten Daten allen registrierten Klienten zur Verfügung gestellt werden sollten ), werden nun konsequenterweise bei den Zugriffen auf nicht erlaubte Ressourcen HTTP-Statuscodes von 403 ( Forbidden ) anstelle von 404 ( nicht gefunden ) zurückgegeben.

Wenn Änderungen an bestehenden Modell-Klassen vorgenommen wurden, sind diese als neue Klassen mit dem Postfix "V11" eingefügt worden.
Beispiele Historie -> HistorieV11, Vermarkter -> VermarkterV11.

Hinweis: Diese Änderungen betreffen jedoch nur die zusätzlich ausgegebenen (Meta-)Informationen / Views!
Die relevante Klasse Sender, in der alle Tarifinformationen pro Jahr enthalten sind, bleibt unverändert.

Änderungen zu Version 1.1

Sender Endpunkte
  • Im Senderbereich wurden bisher nicht vergebene Operation-Ids für die Endpunkte eingeführt, um Code-Generatoren für API-Clients besser zu unterstützen.
  • Die vorherige Operation-Id für den Endpunkt ../Sender/{id}?jahr={jahr} wurde dem allgemeinen jetzt verwendeten Benennungsschema zufolge von "SenderNachId" in "GetSenderNachId" umbenannt.
  • Für den Rückgabetyp "SenderPreisliste" wurde die Schreibweise des Feldes "giltbis" in "giltBis" geändert, um eine konsistentere Bezeichnung zu gewährleisten.
  • Außerdem wurde eine Inkonsistenz bei diesem Endpunkt ../Sender/Preislisten beseitigt. So wird jetzt anstelle eines leeren Arrays der Statuscode 404 zurückgegeben, wenn zum angegebenen Referenzdatum keine geänderten / neuen Senderpreislisten gefunden wurde.
  • Es wurde ein zusätzlicher Endpunkt ../Sender/{id}/Historie hinzugefügt, über den sich historische Datenbestände für einen bestimmten Sender abrufen lassen.
  • Der Rückgabetyp und die zurückgelieferte Ergebnismenge des Endpunktes ../Sender/MitVermarktern wurde dahingehend geändert, das nun pro Sender- und Tarifgeneration die jeweilige Vermarkterzuordnung ausgegeben wird. Zusätzlich mitgelieferte Infos sind die EDI-Nummer, Sender- und Vermarkterstatus sowie der jeweilige Gültigkeitszeitraum.
  • Der Rückgabetyp des Endpunktes ../Sender/Aktualisierungen/{abZeitpunkt} wurde in der Definition geändert. Zur konsistenteren Bezeichnung von Datumswerten bei Zeiträumen wurde aus GueltigAb -> GiltAb und entsprechend aus GueltigBis -> GiltBis.
    Außerdem entfiel das nicht genutzte Feld LaufendNummer und anstelle der obsoleten Preislistenbezeichnungen tritt nun das (Tarif-)Jahr.
  • Analog wurde der Rückgabetyp des Endpunktes ../Sender/{id}/{datumUhrzeit}/Preise in der Definition geändert. Zur konsistenteren Bezeichnung von Datumswerten bei Zeiträumen wurde aus AnfangsDatum -> GiltAb und entsprechend aus EndeDatum -> GiltBis.
  • Im Rückgabetyp des Endpunktes ../Sender/Historie wurde das Feld ReferenzJahr durch Jahr ersetzt.
    Ausserdem wurde der bisher nie verwendete InhaltsHash in zwei Felder aufgeteilt, weil es auch zwei Versionen des Jahrespaketes gibt.
    Eine enthält auch die jeweils aufgelösten Schlüssel / Typen etc. und die andere nicht. Zusätzlich wurden diverse Kategorien hinzugefügt, die später möglicherweise genauer spezifizieren, welche Änderungen am Jahrespaket vorgenommen wurden.
  • Die verschiedenen Endpunkte zum Abrufen der Senderjahrespakete wurden vereinheitlicht und es lassen sich historische Datenstände auch in der normalisierten ( also ohne aufgelöste Typschlüssel ) abrufen.
  • Die Rückgabe vom Endpunkt ../Sender/{id}?jahr={jahr} wurde dahingehend geändert, daß abweichend von Version 1.0 nun kein minimales Senderobjekt mit einem leeren Zeiträume-Array zurückgegeben wird, wenn es überhaupt keine Daten für die gewünschte Tarifgeneration gibt. Statt dessen wird nun StatusCode 404 = Not found ausgegeben.
  • Der Endpunkt GetSenderInfosAlsXml wird durch GetSenderJahresPaketAlsXml ersetzt, wobei hier nun anstelle eines konkreten Kalenderdatums das (Tarif-)Jahr erwartet wird.
  • Diejenigen Endpunkte, über die sich bisher für ein Datum ( richtete sich nach Studienzeiträumen ) für die Senderverbreitungsgebiete und Kombinationsmitglieder abrufen ließen, wurden dahingehend geändert, dass nun eine konkrete Untersuchungszeitraum-Id anstelle des Datums übergeben werden muß.
Vermarkter Endpunkte
  • Der Endpunkt für das Abrufen aller Vermarkter wurde um bisher nicht genutzte Filter- / Ausgabemöglichkeiten bereinigt. und der Rückgabetyp auf VermarkterV11 umgestellt.
  • Die vorherige Operation-Id für den Endpunkt ../Vermarkter/{id} wurde dem allgemeinen jetzt verwendeten Benennungsschema zufolge von "VermarkterNachId" in "GetVermarkterNachId" umbenannt.
  • Die optionale Ausgabe der zugeordneten Sender pro Vermarkter wurde ebenfalls auf das geänderte Objekt LetzteSenderAngabenV11 umgestellt.
    Ausserdem werden hier nun die konkreten Datumswerte der letzten Senderzuordnung für den angefragten Vermarkter ausgegeben und nicht, wie bei der vorherigen Version, nur die jeweils aktuellsten Informationen pro Sender.
Typen Endpunkte
  • Der Endpunkt für das Abrufen aller Typen wurde auf den Rückgabetyp AlleTypenV11 umgestellt, weil hierin auch die geänderten Targetingausprägungen enthalten sind.
  • Die Targetingmerkmalsausprägungen enthalten nun anstelle einer Zeichenkette "Filter" eine eindeutige numerische Id.