96 lines
4.0 KiB
C#
96 lines
4.0 KiB
C#
using EnvelopeGenerator.Application.Contracts.Services;
|
|
using EnvelopeGenerator.Application.EnvelopeHistories.Queries.Read;
|
|
using Microsoft.AspNetCore.Authorization;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
using static EnvelopeGenerator.Common.Constants;
|
|
|
|
|
|
namespace EnvelopeGenerator.GeneratorAPI.Controllers;
|
|
|
|
/// <summary>
|
|
/// Dieser Controller stellt Endpunkte für den Zugriff auf die Umschlaghistorie bereit.
|
|
/// </summary>
|
|
[Route("api/[controller]")]
|
|
[ApiController]
|
|
[Authorize]
|
|
public class HistoryController : ControllerBase
|
|
{
|
|
private readonly ILogger<HistoryController> _logger;
|
|
|
|
private readonly IEnvelopeHistoryService _service;
|
|
|
|
/// <summary>
|
|
/// Konstruktor für den HistoryController.
|
|
/// </summary>
|
|
/// <param name="logger">Der Logger, der für das Protokollieren von Informationen verwendet wird.</param>
|
|
/// <param name="service">Der Dienst, der für die Verarbeitung der Umschlaghistorie verantwortlich ist.</param>
|
|
public HistoryController(ILogger<HistoryController> logger, IEnvelopeHistoryService service)
|
|
{
|
|
_logger = logger;
|
|
_service = service;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Ruft die verfügbaren Referenztypen ab und gibt sie als Schlüssel-Wert-Paare zurück.
|
|
/// </summary>
|
|
/// <returns>Ein Ok-Ergebnis mit einem Wörterbuch, das die Referenztypen als Schlüssel-Wert-Paare enthält.</returns>
|
|
/// <response code="200">Die Anfrage war erfolgreich, und die Referenztypen werden zurückgegeben.</response>
|
|
/// <response code="400">Die Anfrage war ungültig oder unvollständig.</response>
|
|
/// <response code="401">Der Benutzer ist nicht authentifiziert.</response>
|
|
/// <response code="403">Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.</response>
|
|
/// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
|
|
[HttpGet("reference-type")]
|
|
[Authorize]
|
|
public IActionResult GetReferenceTypes()
|
|
{
|
|
// Enum zu Schlüssel-Wert-Paar
|
|
var referenceTypes = Enum.GetValues(typeof(ReferenceType))
|
|
.Cast<ReferenceType>()
|
|
.ToDictionary(rt =>
|
|
{
|
|
var key = rt.ToString();
|
|
var keyAsCamelCase = char.ToLower(key[0]) + key[1..];
|
|
return keyAsCamelCase;
|
|
}, rt => (int)rt);
|
|
|
|
return Ok(referenceTypes);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Ruft die gesamte Umschlaghistorie basierend auf den angegebenen Abfrageparametern ab.
|
|
/// </summary>
|
|
/// <param name="history">Die Abfrageparameter, die die Filterkriterien für die Umschlaghistorie definieren.</param>
|
|
/// <returns>Eine Liste von Historieneinträgen, die den angegebenen Kriterien entsprechen, oder nur der letzte Eintrag.</returns>
|
|
/// <response code="200">Die Anfrage war erfolgreich, und die Umschlaghistorie wird zurückgegeben.</response>
|
|
/// <response code="400">Die Anfrage war ungültig oder unvollständig.</response>
|
|
/// <response code="401">Der Benutzer ist nicht authentifiziert.</response>
|
|
/// <response code="403">Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.</response>
|
|
/// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
|
|
[HttpGet]
|
|
[Authorize]
|
|
public async Task<IActionResult> GetAllAsync([FromQuery] ReadEnvelopeHistoryQuery history)
|
|
{
|
|
ReferenceType? refTypEnum = history.ReferenceType;
|
|
bool withReceiver = false;
|
|
bool withSender = false;
|
|
|
|
switch (refTypEnum)
|
|
{
|
|
case ReferenceType.Receiver:
|
|
withReceiver = true;
|
|
break;
|
|
case ReferenceType.Sender:
|
|
withSender = true;
|
|
break;
|
|
}
|
|
|
|
var histories = await _service.ReadAsync(
|
|
envelopeId: history.EnvelopeId,
|
|
referenceType: refTypEnum,
|
|
withSender: withSender,
|
|
withReceiver: withReceiver);
|
|
|
|
return Ok(histories);
|
|
}
|
|
}
|