Interaktionen mit dem Untersuchungsplan
Dieser Use Case beschreibt die fachlichen Interaktionen mit einem Untersuchungsplan. Die folgenden Abschnitte zeigen, wie der XML-Body vorbereitet, der Nachrichtenkopf angepasst und der passende REST-Kontext für die Übermittlung bestimmt wird.
/api/v1/xwasser/v100?context=<r>Weitere Informationen zu Basis-URLs und Umgebungen stehen im Kapitel Endpunkte.
XWasser als fachliche Grundlage Für Aufbau, Schema und fachliche Befüllung des XML-Bodys bleibt XWasser maßgeblich. Als technische Orientierung kann zusätzlich das xoev-xwasser-rs genutzt werden.
XML-Body als Ausgangspunkt
Um einen XWasser-konformen XML-Body zu erstellen, orientieren Sie sich an der detaillierten Erläuterung zum Body des Prüfberichts. Die dort beschriebene Nachrichtenstruktur mit Nachrichtenkopf, Vorgang und XWasser-Body ist auch für den Untersuchungsplan maßgeblich. Alternativ können Sie zur initialen Erstellung auch einen über die SHAPTH-Weboberfläche erstellten Untersuchungsplan als XML-Datei direkt herunterladen und diesen entsprechend anpassen.
Untersuchungsplan herunterladen ist die Voraussetzung für die weiteren Schritte aller Interaktionen.
Nachrichtenkopf anpassen
Bei allen Interaktionen muss der Nachrichtenkopf zum jeweiligen Vorgang passen. Insbesondere sind autor und leser auf die beteiligten Akteure anzupassen. Der Nachrichtentyp bleibt dabei vorgang.transportieren.2010.
r des Akteurs ermitteln
Vor dem Senden einer Interaktion wird der Wert r des sendenden Akteurs über die passende GraphQL-List-Abfrage (z. B. officialList / officialById bei Behörden, ...) ermittelt. Dieser Schritt ist erforderlich, damit die XWasser-Nachricht anschließend gegen den REST-Endpunkt /api/v1/xwasser/v100?context=<r> gesendet werden kann.
Interaktionen
| Interaktion | Ausgangsbasis | Worauf zu achten ist |
|---|---|---|
| Erstellen | Neu erzeugter XWasser-Body oder angepasste XML-Ausgangsdatei. | Der Untersuchungsplan muss fachlich vollständig sein und im Nachrichtenkopf korrekt adressiert werden. |
| Hochladen / versenden | Fertige XML-Datei des Untersuchungsplans. | Die XWasser-Nachricht wird über den gemeinsamen REST-Endpunkt übermittelt. |
| Verbessern | Bestehender Untersuchungsplan, der als XML-Datei heruntergeladen und angepasst wurde. | Nachrichtenkopf und fachliche Inhalte müssen zum Verbesserungsvorgang passen. |
| Bestätigen | Untersuchungsplan, der durch den zuständigen Akteur bestätigt wird. | Der bestätigende Akteur und die Empfängerangaben müssen im Nachrichtenkopf korrekt gesetzt sein. |
| Weiterleiten | Untersuchungsplan, der an einen weiteren Akteur übermittelt wird. | Die Adressierung im Nachrichtenkopf muss auf den neuen Empfänger angepasst werden. |
Endpoint und Kontext
Die angepasste XWasser-Nachricht wird per POST gegen den REST-Endpunkt mit dem Query-Parameter context gesendet. Dieser Kontextwert wird nicht frei vergeben, sondern aus dem Feld r der passenden GraphQL-List-Abfrage (z. B. officialList / officialById bei Behörden, ...) des jeweiligen Akteurtyps übernommen.
POST /api/v1/xwasser/v100?context=<r>
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/xml
<xwas:vorgang.transportieren.2010>
...
</xwas:vorgang.transportieren.2010>