Zum Hauptinhalt springen

Abruf von Ereignissen über Event Log

Die Ereignisse eines Vorgangs können über den Endpunkt GET /v1/cases/{caseId}/events des Zustelldienstes abgerufen werden. Der Zustelldienst liefert das Ereignisprotokoll (Event Log) zurück, eine Liste mit allen Ereignissen eines Vorgangs. Der Event Log enthält die Ereignisse bzw. Statusübergänge.

Hinweis

Die Authentizität und Integrität der aus dem Event Log abgerufenen Ereignisse SOLLTE bei jedem Abruf geprüft werden. Die notwendigen Prüfungen sind im Artikel Prüfung eines Security Event Token beschrieben.

Über die Queryparameter offset und limit können Sie das Gesamtergebnis in kleinere Listen aufteilen. Die maximale Anzahl der Ereignisse (Events) in einer Teilliste (limit) beträgt 500 Events. Der Zustelldienst sendet die Ereignisse als SETs (Security Event Tokens) zurück.

Mit dem .NET-SDK erfragen Sie nicht das Ereignisprotokoll (EventLog) eines Vorgangs vom Zustelldienst.
Sie erfragen vielmehr mit der Methode GetStatusForSubmissionAsync() der Klasse Sender direkt den Status einer gesendeten Einreichung:

sender.GetStatusForSubmissionAsync(sentSubmission);

Sie finden auf der Seite Einreichung versenden ein Beispiel für das Senden einer Einreichung. Zudem finden Sie auf der Seite Einreichung anlegen ein Beispiel für das Anlegen einer Einreichung. Der Quellcode oben ist ein Auszug aus dem Projekt ConsoleAppExample, das im Repository Codebeispiele - examples der FITKO hinterlegt ist. Eine Beschreibung des .NET-SDKs finden Sie im Hauptmenü unter "SDKs > .NET-SDK".

In einem Security Event Token (SET) sind die folgenden Informationen enthalten:

  • $schema: URI des zugrunde liegenden JSON Schemas. Mit diesem kann der SET Payload geprüft werden.
  • jti (JWT ID): Er hat die eindeutige ID 8538165b-9ce3-4097-871d-5b9581a3b4d9
  • iss (Issuer): Er wurde vom Empfänger des Zustellpunktes (Destination) 40847c29-06aa-40e2-bf28-c29884c694c4 ausgestellt.
  • iat (Issued At): Er wurde am 04.06.2021 um 10:48:52 (Unixzeit 1622796532) aufgezeichnet
  • sub (Subject): Er betrifft die Einreichung 02bf1d9f-282d-4abf-810a-c4104baf0afe
  • txn (Transaction Identifier): Die Submission gehört zur Vorgangsreferenz (Case) 452b5ee6-35df-441a-bd39-6141723cf914
  • events: Die Submission wurde akzeptiert (accept-submission)

Aus dem Feld events des SETs im Beispiel oben lässt sich ableiten, dass der aktuelle Status der Einreichung in diesem Vorgang (Case) accepted ist (aufgrund des Ereignisses accept-submission). Der Zeitpunkt des Übergangs war 10:48:52, am 04.06.2021.

SETs sind signiert​

Da alle SETs im Event Log signiert sind, kann diese Signatur überprüft werden. Die Überprüfung ist im Artikel Prüfung eines Security Event Token (SET) beschrieben.

Abruf von Ereignissen zu einer Einreichung bzw. zu einer Antwort​

Seit Version 1.7.0 der Submission API können auch die Ereignisse zu einer bestimmten Einreichung über den Endpunkt GET /v1/submisisons/{submisisonId}/events bzw. zu einer Antwort über den Endpunkt GET /v1/replies/{replyId}/events ausgelesen werden.

Die neuen Endpunkte verhalten sich analog zum bereits beschriebenen Endpunkt zum Abruf sämtlicher Ereignisse eines Vorgangs, liefern aber bloß die Ereignisse zurück, die die entsprechende Einreichung bzw. Antwort betreffen. Die Struktur der gelieferten Ereignisse entspricht dabei exakt der des existierenden Endpunkts.