VCR.NET 4.1 – Schnittstelle zum Pflegen von Aufträgen und Aufzeichnungen

Im Zentrum der Pflege von Aufträgen und Aufzeichnungen steht der neue REST Web Service edit. Mit seinen Methoden ist es möglich, alle notwendigen Änderungen vorzunehmen:

  • GET: dieser Aufruf liefert grundsätzlich die aktuellen Informationen über eine einzelne Aufzeichnung eines bestimmten Auftrags. Allerdings erlauben die Parameter des Aufrufs weitere Feineinstellungen zum gewünschten Verhalten. Da ist zum einen der Name der REST Ressource (vcr.net/edit/ressource). Handelt es sich dabei um eine Kombination aus den eindeutigen Kennungen eines Auftrags (32 Zeichen) und einer Aufzeichnung im Auftrag (32 Zeichen), so werden die Daten von genau dieser Aufzeichnung und diesem Auftrag gemeldet. Soll zu einem bestimmten Auftrag eine neue Aufzeichnung angelegt werden, so wird als Name der Ressource ein Stern (*) gefolgt von der eindeutigen Kennung eines Auftrags (32 Zeichen) verwendet. Die Antwort enthält dann alle Daten des Auftrags und eine leere Aufzeichnung. Ist der Name der Ressource nur ein Stern (*) so wird auch ein leerer
    Auftrag zusätzlich zur leeren Aufzeichnung gemeldet. Im Web Client von VCR.NET 4.1 werden die letzten beiden Varianten verwendet, um neue Aufzeichnungen direkt aus der Programmzeitschrift zu erstellt. In diesem Fall wird als Parameter (?epg=) die eindeutige Kennung eines Eintrags aus einer Programmzeitschrift übergeben – in einem wohldefinierten Format, da hier nicht weiter vorgestellt werden soll. Der Web Service füllt dann Auftrag und Aufzeichnung mit den entsprechenden Informationen in die Antwort des Aufrufs.
  • DELETE: als Name der Ressource wird die bereits beschriebene Kombination aus den eindeutigen Kennungen von Auftrag und Aufzeichnung verwendet und so die Aufzeichnung identifiziert, die entfernt werden soll. Handelt es sich dabei um die einzige Aufzeichnung eines Auftrags, so wird der Auftrag als Ganzes in das Archiv übertragen.
  • PUT: dient zur Aktualisierung einer bestehenden Aufzeichnung. Der Name der REST Ressource enthält wieder die beiden eindeutigen Kennung und als Daten werden die gewünschten neuen Einstellungen für Auftrag und Aufzeichnung erwartet.
  • POST: das Anlegen von neuen Aufzeichnungen wird in zwei Varianten angeboten. In allen Fällen werden als Daten die gewünschten Einstellungen von Auftrag und Aufzeichnungen erwartet. In der ersten Variante wird kein Name für die REST Ressource angegeben (vcr.net/edit) und eine neue Aufzeichnung in einem neuen Auftrag angelegt. Ansonsten wird als Name die eindeutige Kennung eines Auftrags angegeben und eine neue Aufzeichnung zu diesem hinzugefügt, wobei gleichzeitig die Einstellungen des Auftrags aktualisiert werden können. In jedem Fall liefert der Aufruf als Antwort eine einfache Zeichenkette mit den eindeutigen Kennungen von Auftrag und Aufzeichnung – die Kennung des Auftrags bezeichnet dann eventuell einen bereits vor dem Aufruf existierenden Auftrag.

In VCR.NET 4.1 ist erst einmal keine gesonderte Fehlerbehandlung vorgesehen. Auch wenn der aktuelle Web Client viele Prüfungen vornimmt, kann es durchaus zu Fehlersituationen kommen. In diesem Fall wird im Web Service eine .NET Ausnahme aufgelöst und als JSON Objekt zum Client gemeldet. Zukünftige Versionen des Web Services werden hier eventuell eigene Mechanismen (ergänzend) anbieten.

Speichere in deinen Favoriten diesen permalink.

Kommentare sind geschlossen.