SHAPTH
Use Case
REST · vorgang.transportieren.2010

Prüfbericht weiterleiten

Dieser Use Case beschreibt die fachliche Weiterleitung eines bereits vorhandenen Prüfberichts. Im Mittelpunkt stehen die Anpassung des Nachrichtenkopfs und die erneute Übermittlung über den REST-Endpunkt.

Berechtigung
rollen- und kontextabhängiger Zugriff auf Prüfberichte
REST
POST
/api/v1/xwasser/v100?context=<r>

Weitere Informationen zu Basis-URLs und Umgebungen stehen im Kapitel Endpunkte.

Playground(nur GraphQL)

Voraussetzung: Prüfbericht herunterladen Prüfbericht herunterladen beschreibt, wie ein bestehender Prüfbericht über qualityReports oder qualityReportById gefunden, die aktuelle Download-URL ermittelt und die XML-Datei per GET /api/v1/download/report?u=... abgerufen wird. Die heruntergeladene XML-Datei ist die Ausgangsdatei für die Weiterleitung.

r des Akteurs ermitteln Vor dem Senden der Weiterleitung 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 angepasste XWasser-Nachricht anschließend gegen /api/v1/xwasser/v100?context=<r> gesendet werden kann.


Nachrichtenkopf anpassen

Die heruntergeladene XML-Datei wird für den neuen Weiterleitungsvorgang angepasst. Der Nachrichtenkopf muss zur konkreten Weiterleitung passen. Insbesondere sind autor und leser auf die beteiligten Akteure zu setzen.

Typischerweise wird außerdem ein Akteur ergänzt, damit die Weiterleitung korrekt adressiert ist. Der Nachrichtentyp bleibt vorgang.transportieren.2010.

BereichAnpassung für die Weiterleitung
nachrichtenUUIDFür den erneuten Versand neu vergeben.
autorAuf den Akteur setzen, der die Weiterleitung ausführt.
leserAuf den Empfänger der weitergeleiteten Nachricht setzen.
AkteurAkteur ergänzen, damit der Prüfbericht korrekt adressiert ist.

Weiterleitung senden

Die angepasste XWasser-Nachricht wird per POST gegen den REST-Endpunkt mit dem Query-Parameter context gesendet. Der Wert für context wird aus dem Feld r der passenden GraphQL-List-Abfrage (z. B. officialList / officialById bei Behörden, ...) des gewünschten Akteurtyps übernommen.

REST-Endpunkt
POST /api/v1/xwasser/v100?context=<r>
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/xml

<xwas:vorgang.transportieren.2010>
...
</xwas:vorgang.transportieren.2010>

On this page