2.1 Händelselogg och Valideringsrapport - Underskriftstjänsten Webb och API

Innehållsförteckning

Revisionshistorik



Version

Datum

Författare

Kommentar

Version

Datum

Författare

Kommentar

0.1

Nov 21, 2023 

Christoffer Rydberg, Maria Richert och Simon Petersohn Esentals

Första version

0.2

Nov 27, 2023 

Christoffer Rydberg

Uppdaterat enligt kommentar från NMT

0.3

Dec 7, 2023 

Christoffer Rydberg

Uppdaterat bilden för valideringsrapporten

1.0

Dec 15, 2023 

@Former user (Deleted) 

Godkänd

1.1

Dec 20, 2023 

Helene Kvick

uppdaterad med info kring UTC-tid

1.2

Dec 20, 2023 

Tomas Fransson

Godkänd





Valideringsrapport

Beskrivning

Valideringsrapporten är ett dokument som skapas efter att ett signeringsuppdrag har slutförts dvs när alla signatärer har signerat dokumentet. Valideringsrapporten är enbart synlig för Användanren som skapade signeringsuppdraget. Administratören kan använda valideringsrapporten som ett stöddokument vid granskning av signeringar och för att validera att allting har gått rätt till.

Valideringsrapporten innehåller UppdragsID som är ett unikt id för varje signeringsuppdrag samt tid och datum när uppdraget skapades och när det blev färdigställt. Observera att tiden för skapande av uppdrag samt signeringarna är i UTC tid vilket gör att det avviker från svensk tid.
Det innehåller även ett TransaktionsID som är ett unikt nummer som ges till varje transaktion som du utförts.

Dokument

Innehåller filnamn på de bifogade filer som har signerats och vad för storlek filen har. Hashkoden är ett numeriskt värde med en fast längd som unikt identifierar data.

Roller

Skapat av

Här ser man vem som har skapat updraget, när det initerades samt vilken organisation som signeringsuppdraget tillhör. PersonId är HSA-id på den som skapat signeringsuppdraget

Signatärer

Signatär innehåller information med Namn, Person ID, E-post. Legitimation som finns under signatären är den E-Legitimation som använts för att signera signeringsuppdraget.

Ett Transaktions Id som finns under Legitimationen är ett unikt nummer som kan användas för att identifiera den enskilda transaktionen som står bakom signeringen i underliggande signeringstjänst.

Valideringsresultat

Visar resultatet av uppdraget om det har godkänts (TOTAL_PASSED).



Valideringsrapport för Underskriftstjänsten

Nedladdning av valideringsrapport via API

Se användningsfall AF API-4 i 2.1 SAD - Underskriftstjänsten Webb och API

Nedladdning av valideringsrapport via Webb

När ett signeringsuppdrag är signerat av alla signatärer så har skaparen av signeringsuppdraget möjlighet att ladda ned valideringsrapporten.

Exempel, på hur man laddar hem valideringsrapporten från uppdragets enskilda sida

Exempel, på hur man laddar hem valideringsrapporten från översikten "Mina uppdrag"



Händelselogg för Underskriftstjänsten Webb

Beskrivning

Händelseloggen är ett dokument som skapas efter att ett signeringsuppdrag har slutförts dvs när alla signatärer har signerat dokumentet. Händelseloggen är enbart tillgänglig för Användanren som skapade signeringsuppdraget. Administratören kan använda händelseloggen för att se alla händelser som är kopplade till det specifika signeringsuppdraget.

Händelseloggen visar information om signeringsuppdragets olika händelser. Dokumentet innehåller tidpunkter för olika händelser som har skett och vilken aktör som har utfört händelsen.

Aktör

Kolumnen Aktör innehåller namn och HSA-id alternativt Personnummer beroende på vem som har signerat och vilken underskriftsprofil som varit angiven på just den signatären.

Händelse

Kolumnen Händelse visar alla händelser för uppdraget, till exempel vilken signatär(HSA-id) som har blivit tillagd, vilket dokument som har visats och signeringsflöde.

Händelselogg för Underskriftstjänsten API

Händelseloggen visar information om signeringsuppdragets olika händelser och det kan hämtas ut genom endpointen /signRequests/{signRequestId}/history

  1. signRequestId: En unik identifierare (UUID) för den relaterade signaturförfrågan.

  2. dateTime: Datum och tid då åtgärden utfördes, angiven i UTC-tid.

  3. action: Typen av åtgärd som utfördes, t.ex., "created" för skapande eller "updated" för uppdateringar.

  4. description: En beskrivning av åtgärden, t.ex., "Signature request created" eller "Document entry created".

  5. actor: Identifierare för den aktör som utförde åtgärden, t.ex., "system-id".

  6. metadata: Extra information relaterad till åtgärden. I det givna exemplet finns en metadataattribut "documentId" som innehåller en unik identifierare för det skapade dokumentet. Om metadata inte finns, kommer det att vara en tom lista ([]).

Genom att analysera dessa attribut kan du som användare förstå när och hur olika åtgärder relaterade till signeringsuppdraget har utförts och vilken aktör som var ansvarig. Metadata ger extra detaljer.

Exempel response
[ { "signRequestId": "25375fbe-4a04-47e1-b7ba-a6b266681111", "dateTime": "2021-01-25T14:30:00Z", "action": "created", "description": "Signature request created", "actor": "system-id", "metadata": [] }, { "signRequestId": "25375fbe-4a04-47e1-b7ba-a6b266681111", "dateTime": "2021-01-25T14:40:00Z", "action": "updated", "description": "Document entry created", "actor": "system-id", "metadata": { "documentId": "25375fbe-4a04-47e1-b7ba-a6b266682222" } } ]






Publik Information