AppStd/EnvelopeGenerator
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update comments in HistoryController for clarity

Browse Source 
Improved descriptions of historical records related to sender, receiver, system, and unknown statuses. Enhanced formatting and provided detailed explanations of associated status codes for better readability.
This commit is contained in:
Developer 02 2025-04-11 23:18:30 +02:00
parent 7389909d77
commit fbd09cb570
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs
View File

@ -38,11 +38,14 @@ public class HistoryController : ControllerBase
/// Gibt alle möglichen Verweise auf alle möglichen Status in einem Verlaufsdatensatz zurück. (z. B. DocumentSigned bezieht sich auf Receiver.)
/// Dies wird hinzugefügt, damit Client-Anwendungen sich selbst auf dem neuesten Stand halten können.
/// <list type="bullet">
/// <item><description><c>0</c>: Receiver</description></item>
/// <item><description><c>1</c>: Sender</description></item>
/// <item><description><c>2</c>: System</description></item>
/// <item><description><c>3</c>: Unknown
/// (Ein unbekannter Datensatz weist auf einen möglichen Mangel oder eine Unstimmigkeit im Aktualisierungsprozess der Anwendung hin.)</description></item>
/// <item><description><c>0 - Receiver</c>:
/// Historische Datensätze, die sich auf den Status des Absenders beziehen. Sie haben Statuscodes, die mit 1* beginnen.</description></item>
/// <item><description><c>1 - Sender</c>:
/// Historische Datensätze über den Status der Empfänger. Diese haben Statuscodes, die mit 2* beginnen.</description></item>
/// <item><description><c>2 - System</c>:
/// Historische Datensätze, die sich auf den allgemeinen Zustand des Umschlags beziehen. Diese haben Statuscodes, die mit 3* beginnen.</description></item>
/// <item><description><c>3 - Unknown</c>:
/// Ein unbekannter Datensatz weist auf einen möglichen Mangel oder eine Unstimmigkeit im Aktualisierungsprozess der Anwendung hin.</description></item>
/// </list>
/// </summary>
/// <returns></returns>
@ -97,8 +100,8 @@ public class HistoryController : ControllerBase
/// </summary>
/// <param name="related">
/// Abfrageparameter, der angibt, auf welche Referenz sich der Status bezieht.
/// 0 - Sender: Die Status des Senders werden von der Anwendung Envelope.Form aktualisiert und haben die Codes, die mit 1* beginnen.
/// 1 - Receiver: Die Status der Empfänger werden von der Anwendung Envelope.Web aktualisiert und haben die Codes, die mit 2* beginnen.
/// 0 - Sender: Historische Datensätze, die sich auf den Status des Absenders beziehen. Sie haben Statuscodes, die mit 1* beginnen.
/// 1 - Receiver: Historische Datensätze über den Status der Empfänger. Diese haben Statuscodes, die mit 2* beginnen.
/// 2 - System: Diese werden durch Datenbank-Trigger aktualisiert und sind in den Tabellen EnvelopeHistory und EmailOut zu finden.Sie arbeiten
/// integriert mit der Anwendung EmailProfiler, um E-Mails zu versenden und haben die Codes, die mit 3* beginnen.
/// </param>