/* * API du serveur de l'application de digitalisation des EP * * API qui sra utilisée afin de faire communiquer le client et le serveur ainsi que le serveur et la boîte noire. * * OpenAPI spec version: 1.3.6 * * Generated by: https://github.com/swagger-api/swagger-codegen.git */ using System; using System.Collections.Generic; using Microsoft.AspNetCore.Mvc; using Swashbuckle.AspNetCore.Annotations; using Swashbuckle.AspNetCore.SwaggerGen; using Newtonsoft.Json; using System.ComponentModel.DataAnnotations; using IO.Swagger.Attributes; using IO.Swagger.Security; using Microsoft.AspNetCore.Authorization; using IO.Swagger.DTO; using System.ComponentModel; using EPAServeur.IServices; using Microsoft.Extensions.Logging; using System.Threading.Tasks; using EPAServeur.Exceptions; using Microsoft.EntityFrameworkCore; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Hosting; using Microsoft.AspNetCore.Http; namespace IO.Swagger.Controllers { /// /// /// [ApiController] public class FormationsApiController : ControllerBase { private readonly IFormationService formationService; private readonly ILogger logger; private readonly IWebHostEnvironment env; public FormationsApiController(IFormationService _formationService, ILogger _logger, IWebHostEnvironment _env) { formationService = _formationService; logger = _logger; env = _env; } /// /// /// /// Créer une nouvelle formation. /// /// Formation créée avec succès /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// L’opération ne peut pas être effectuée car certaines données sont manquantes /// Une erreur est survenue sur le serveur [HttpPost] [Route("/api/formations")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("AddFormation")] [SwaggerResponse(statusCode: 201, type: typeof(FormationDTO), description: "Formation créée avec succès")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 415, type: typeof(ErreurDTO), description: "L’opération ne peut pas être effectuée car certaines données sont manquantes")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task AddFormation([FromBody] FormationDTO body) { if (env.IsDevelopment()) logger.LogInformation("Ajout d'une nouvelle formation."); try { body = await formationService.AddFormationAsync(body); } catch (FormationInvalidException e) { if (env.IsDevelopment()) logger.LogInformation(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = e.Message, }; return StatusCode(erreur.Code.Value, erreur.Message); } catch (DbUpdateException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur est survenue sur le serveur lors de l'ajout de la formation.", }; return StatusCode(erreur.Code.Value, erreur); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur.", }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Nouvelle formation ajoutée."); return Created("", body); } /// /// /// /// Supprimer une formation par son id. /// Id d'une formation /// Formation supprimée avec succès /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// La ressource n'a pas été trouvée /// Une erreur est survenue sur le serveur [HttpDelete] [Route("/api/formations/{idFormation}")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("DeleteFormation")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 404, type: typeof(ErreurDTO), description: "La ressource n'a pas été trouvée")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task DeleteFormation([FromRoute][Required] long idFormation) { try { if (env.IsDevelopment()) logger.LogInformation("Suppresion de la formation {idFormation}.", idFormation); FormationDTO formation = await formationService.DeleteFormationByIdAsync(idFormation); } catch (FormationNotFoundException e) { if (env.IsDevelopment()) logger.LogInformation(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status404NotFound, Message = e.Message }; return NotFound(erreur); } catch (DbUpdateConcurrencyException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = string.Format("La formation {0} n'a pas pu être supprimée car elle est prise par une autre ressource.", idFormation) }; return StatusCode(erreur.Code.Value, erreur); } catch (DbUpdateException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur est survenue sur le serveur lors de la suppression de la formation." }; return StatusCode(erreur.Code.Value, erreur); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Formation {idFormation} supprimée avec succès.", idFormation); return NoContent(); } /// /// /// /// Récupérer une formation par son id. /// Id d'une formation /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// La ressource n'a pas été trouvée /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/formations/{idFormation}")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetFormationById")] [SwaggerResponse(statusCode: 200, type: typeof(FormationDTO), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 404, type: typeof(ErreurDTO), description: "La ressource n'a pas été trouvée")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetFormationById([FromRoute][Required] long idFormation) { if (env.IsDevelopment()) logger.LogInformation("Récupération de la formation {idFormation}.", idFormation); FormationDTO formationDTO = null; try { formationDTO = await formationService.GetFormationByIdAsync(idFormation); } catch (FormationNotFoundException e) { if (env.IsDevelopment()) logger.LogInformation(e.Message); ErreurDTO erreurDTO = new ErreurDTO() { Code = StatusCodes.Status404NotFound, Message = e.Message }; return NotFound(erreurDTO); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Formation {idFormation} récupérée.", idFormation); return Ok(formationDTO); } /// /// /// /// Récupérer la liste des formations. /// id de l'agence à laquelle sont rattachées les données à récupérer /// liste des ids des statuts des formations à récupérer /// Indique si les données sont récupérées dans l'ordre croissant ou non /// Numéro de la page du tableau à afficher /// Nombre d’élément maximum à afficher dans le tableau /// Texte permettant de filtrer les données /// Colonne du tableau sur lequel le tri devra être effectué /// Date à partir de laquelle les données son récupérées /// Date jusqu'à laquelle les données sont récupérées /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/formations")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetFormations")] [SwaggerResponse(statusCode: 200, type: typeof(List), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetFormations([FromQuery] long? idAgence, [FromQuery] List idStatuts, [FromQuery] bool? asc, [FromQuery] int? numPage, [FromQuery][Range(5, 100)][DefaultValue(15)] int? parPAge, [FromQuery] string texte, [FromQuery] string tri, [FromQuery] DateTime? dateDebut, [FromQuery] DateTime? dateFin) { if (env.IsDevelopment()) logger.LogInformation("Récupération de la liste des formations."); IEnumerable formations = null; try { formations = await formationService.GetFormationsAsync(idAgence, idStatuts, asc, numPage, parPAge, texte, tri, dateDebut, dateFin); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Liste des formations récupérée."); return Ok(formations); } /// /// /// /// Récupérer le nombre total de formations. /// id de l'agence à laquelle sont rattachées les données à récupérer /// liste des ids des statuts des formations à récupérer /// Indique si les données sont récupérées dans l'ordre croissant ou non /// Numéro de la page du tableau à afficher /// Nombre d’élément maximum à afficher dans le tableau /// Texte permettant de filtrer les données /// Colonne du tableau sur lequel le tri devra être effectué /// Date à partir de laquelle les données son récupérées /// Date jusqu'à laquelle les données sont récupérées /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/formations/count")] //[Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetFormationsCount")] [SwaggerResponse(statusCode: 200, type: typeof(long?), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetFormationsCount([FromQuery] long? idAgence, [FromQuery] List idStatuts, [FromQuery] int? numPage, [FromQuery][Range(5, 100)][DefaultValue(15)] int? parPAge, [FromQuery] string texte, [FromQuery] DateTime? dateDebut, [FromQuery] DateTime? dateFin) { if (env.IsDevelopment()) logger.LogInformation("Récupération du nombre total de formations."); long count = 0; try { count = await formationService.GetFormationsCountAsync(idAgence, idStatuts, numPage, parPAge, texte, dateDebut, dateFin); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Nombre total de formations récupéré."); return Ok(count); } /// /// /// /// Récupérer la liste des modes de formation. /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/modesformation")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetModesFormation")] [SwaggerResponse(statusCode: 200, type: typeof(List), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetModesFormation() { if (env.IsDevelopment()) logger.LogInformation("Récupération de la liste des modes de formation."); IEnumerable modeFormations = null; try { modeFormations = await formationService.GetModesFormationAsync(); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Liste des modes de formation récupérée."); return Ok(modeFormations); } /// /// /// /// Récupérer la liste des origines de formation. /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/originesformation")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetOriginesFormation")] [SwaggerResponse(statusCode: 200, type: typeof(List), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetOriginesFormation() { if (env.IsDevelopment()) logger.LogInformation("Récupération de la liste des origines de formation."); IEnumerable origineFormations = null; try { origineFormations = await formationService.GetOriginesFormationAsync(); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Liste des origines de formation récupérée."); return Ok(origineFormations); } /// /// /// /// Récupérer la liste des statuts de formation. /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/statutsformation")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetStatutsFormation")] [SwaggerResponse(statusCode: 200, type: typeof(List), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetStatutsFormation() { if (env.IsDevelopment()) logger.LogInformation("Récupération de la liste des statuts de formation."); IEnumerable statutFormations = null; try { statutFormations = await formationService.GetStatutsFormationAsync(); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Liste des statuts de formation récupérée."); return Ok(statutFormations); } /// /// /// /// Récupérer la liste des types de formation. /// OK /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// Une erreur est survenue sur le serveur [HttpGet] [Route("/api/typesformation")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetTypesFormation")] [SwaggerResponse(statusCode: 200, type: typeof(List), description: "OK")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task GetTypesFormation() { if (env.IsDevelopment()) logger.LogInformation("Récupération de la liste des types de formation."); IEnumerable typeFormations = null; try { typeFormations = await formationService.GetTypesFormationAsync(); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Liste des types de formation récupérée."); return Ok(typeFormations); } /// /// /// /// Mettre à jour une formation. /// /// Id d'une formation /// formation mise à jour /// L'utilisateur souhaitant accéder à la ressource n'est pas authentifié /// L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants /// La ressource n'a pas été trouvée /// L’opération ne peut pas être effectuée car certaines données sont manquantes /// Une erreur est survenue sur le serveur [HttpPut] [Route("/api/formations/{idFormation}")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("UpdateFormation")] [SwaggerResponse(statusCode: 401, type: typeof(ErreurDTO), description: "L'utilisateur souhaitant accéder à la ressource n'est pas authentifié")] [SwaggerResponse(statusCode: 403, type: typeof(ErreurDTO), description: "L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants")] [SwaggerResponse(statusCode: 404, type: typeof(ErreurDTO), description: "La ressource n'a pas été trouvée")] [SwaggerResponse(statusCode: 415, type: typeof(ErreurDTO), description: "L’opération ne peut pas être effectuée car certaines données sont manquantes")] [SwaggerResponse(statusCode: 500, type: typeof(ErreurDTO), description: "Une erreur est survenue sur le serveur")] public virtual async Task UpdateFormation([FromBody] FormationDTO body, [FromRoute][Required] long idFormation) { if (env.IsDevelopment()) logger.LogInformation("Mise à jour de la formation d'id {idFormation}.", idFormation); try { body = await formationService.UpdateFormationAsync(idFormation, body); } catch (FormationIncompatibleIdException e) { if (env.IsDevelopment()) logger.LogInformation(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status415UnsupportedMediaType, Message = e.Message, }; return StatusCode(erreur.Code.Value, erreur.Message); } catch (FormationInvalidException e) { if (env.IsDevelopment()) logger.LogInformation(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status415UnsupportedMediaType, Message = e.Message, }; return StatusCode(erreur.Code.Value, erreur.Message); } catch (FormationNotFoundException e) { if (env.IsDevelopment()) logger.LogInformation(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status404NotFound, Message = e.Message }; return NotFound(erreur); } catch (DbUpdateConcurrencyException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = string.Format("La formation {0} n'a pas pu être supprimée car elle est prise par une autre ressource.", idFormation) }; return StatusCode(erreur.Code.Value, erreur); } catch (DbUpdateException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur est survenue sur le serveur lors de la suppression de la formation." }; return StatusCode(erreur.Code.Value, erreur); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = StatusCodes.Status500InternalServerError, Message = "Une erreur inconnue est survenue sur le serveur." }; return StatusCode(erreur.Code.Value, erreur); } if (env.IsDevelopment()) logger.LogInformation("Update effectué avec succès"); return Ok(body); } } }