/* * 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 Microsoft.Extensions.Logging; using EPAServeur.IServices; using System.Threading.Tasks; using IO.Swagger.ClientCollaborateur; using EPAServeur.Exceptions; namespace IO.Swagger.Controllers { /// /// /// [ApiController] public class CollaborateursApiController : ControllerBase { private readonly ICollaborateurService collaborateurService; private readonly ILogger logger; private readonly IAuthorizationService authorizationService; public CollaborateursApiController(ICollaborateurService _collaborateurService, ILogger _logger, IAuthorizationService _authorizationService) { collaborateurService = _collaborateurService; logger = _logger; authorizationService = _authorizationService; } /// /// /// /// Récupérer un collaborateur par son id. /// Id du collaborateur /// 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/collaborateurs/{idCollaborateur}")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetCollaborateurById")] [SwaggerResponse(statusCode: 200, type: typeof(CollaborateurDTO), 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 GetCollaborateurById([FromRoute][Required]Guid? idCollaborateur) { CollaborateurDTO collaborateurDTO; try { collaborateurDTO = await collaborateurService.GetCollaborateurByIdAsync(idCollaborateur); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (CollaborateurNotFoundException e) { ErreurDTO erreurDTO = new ErreurDTO() { Code = 404, Message = e.Message, }; return NotFound(erreurDTO); } catch (Exception e) { logger.LogError(e.Message); //TODO : vérifier des cas d'erreur possible avant ?... ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue sur le serveur", }; return StatusCode(500, erreurDTO); } // Si l'utilisateur connecté est un collaborateur, on vérifie si il est autorisé à accéder au détail du collaborateur if (User.IsInRole("Collaborateur")) { //Le collaborateur récupère ses informations if (!(await authorizationService.AuthorizeAsync(User, collaborateurDTO, "SameMailRequirement")).Succeeded) { ErreurDTO erreurDTO = new ErreurDTO() { Code = 403, Message = "Accès interdit", }; return StatusCode(403, erreurDTO); } //TODO : Le collaborateur récupère les informations d'un collaborateur dont il est référentEP //TODO : Le collaborateur récupère les informations d'un collaborateur dont il est référent de l'EP actuel } return Ok(collaborateurDTO); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(CollaborateurDTO)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 404 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(404, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } /// /// /// /// Récupérer un collaborateur par son mail. /// Mail de l'utilisateur connecté (mail obtenu via le token Keycloak) /// 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/collaborateurs/{mail}/mail")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetCollaborateurByMail")] [SwaggerResponse(statusCode: 200, type: typeof(CollaborateurDTO), 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 GetCollaborateurByMail([FromRoute][Required]string mail) { CollaborateurDTO collaborateurDTO; try { collaborateurDTO = await collaborateurService.GetCollaborateurByMailAsync(mail); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (CollaborateurNotFoundException e) { ErreurDTO erreurDTO = new ErreurDTO() { Code = 404, Message = e.Message, }; return NotFound(erreurDTO); } catch (Exception e) { logger.LogError(e.Message); //TODO : vérifier des cas d'erreur possible avant ?... ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue sur le serveur", }; return StatusCode(500, erreurDTO); } // Si l'utilisateur connecté est un collaborateur, on vérifie si il est autorisé à accéder au détail du collaborateur if (User.IsInRole("Collaborateur")) { //Le collaborateur récupère ses informations if (!(await authorizationService.AuthorizeAsync(User, collaborateurDTO, "SameMailRequirement")).Succeeded) { ErreurDTO erreurDTO = new ErreurDTO() { Code = 403, Message = "Accès interdit", }; return StatusCode(403, erreurDTO); } //TODO : Le collaborateur récupère les informations d'un collaborateur dont il est référentEP //TODO : Le collaborateur récupère les informations d'un collaborateur dont il est référent de l'EP actuel } return Ok(collaborateurDTO); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(CollaborateurDTO)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 404 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(404, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } /// /// /// /// Récupérer une liste de collaborateurs. /// Liste des rôles auquels appartiennent les collaborateurs (e.g [”CP”, ”Commerciaux”,”RA”]) /// liste des ids des BU auxquelles les données sont rattachées /// 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/collaborateurs")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetCollaborateurs")] [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 GetCollaborateurs([FromQuery]List roles, [FromQuery]List idBUs, [FromQuery]bool? asc, [FromQuery]int? numPage, [FromQuery][Range(5, 100)]int? parPage, [FromQuery]string texte, [FromQuery]string tri, [FromQuery]DateTime? dateDebut, [FromQuery]DateTime? dateFin) { IEnumerable collaborateurs; try { collaborateurs = await collaborateurService.GetCollaborateursAsync(roles, idBUs, asc, numPage, parPage, texte, tri, dateDebut, dateFin); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (Exception e) { logger.LogError(e.Message); ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue", }; return StatusCode(500, erreurDTO); } return Ok(collaborateurs); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(List)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } /// /// /// /// Récupérer la liste des collaborateurs d’un référent. /// Id d'un référent /// 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é /// 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/collaborateurs/referent/{idReferent}")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetCollaborateursByReferent")] [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: 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 GetCollaborateursByReferent([FromRoute][Required]Guid? idReferent, [FromQuery]bool? asc, [FromQuery]int? numPage, [FromQuery][Range(5, 100)]int? parPage, [FromQuery]string texte, [FromQuery]string tri) { IEnumerable collaborateurs; try { collaborateurs = await collaborateurService.GetCollaborateursByReferentAsync(idReferent, asc, numPage, parPage, texte, tri); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (ReferentNotFoundException e) { ErreurDTO erreurDTO = new ErreurDTO() { Code = 404, Message = e.Message, }; return NotFound(erreurDTO); } catch (Exception e) { logger.LogError(e.Message); //TODO : vérifier des cas d'erreur possible avant ?... ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue sur le serveur", }; return StatusCode(500, erreurDTO); } return Ok(collaborateurs); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(List)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 404 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(404, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } /// /// /// /// Récupérer le nombre total de collaborateurs d’un référent. /// Id d'un référent /// Texte permettant de filtrer les donné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/collaborateurs/referent/{idReferent}/count")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetCollaborateursByReferentCount")] [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 GetCollaborateursByReferentCount([FromRoute][Required]Guid? idReferent, [FromQuery]string texte) { int collaborateurs; try { collaborateurs = await collaborateurService.GetCollaborateursCountByReferentAsync(idReferent, texte); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (ReferentNotFoundException e) { ErreurDTO erreurDTO = new ErreurDTO() { Code = 404, Message = e.Message, }; return NotFound(erreurDTO); } catch (Exception e) { logger.LogError(e.Message); //TODO : vérifier des cas d'erreur possible avant ?... ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue sur le serveur", }; return StatusCode(500, erreurDTO); } return Ok(collaborateurs); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(long?)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } /// /// /// /// Récupérer le nombre total de collaborateurs. /// Liste des rôles auquels appartiennent les collaborateurs (e.g [”CP”, ”Commerciaux”,”RA”]) /// liste des ids des BU auxquelles les données sont rattachées /// Texte permettant de filtrer les données /// 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/collaborateurs/count")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetCollaborateursCount")] [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 GetCollaborateursCount([FromQuery]List roles, [FromQuery]List idBUs, [FromQuery]string texte, [FromQuery]DateTime? dateDebut, [FromQuery]DateTime? dateFin) { int collaborateurs; try { collaborateurs = await collaborateurService.GetCollaborateursCountAsync(roles, idBUs, texte, dateDebut, dateFin); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (Exception e) { logger.LogError(e.Message); //TODO : vérifier des cas d'erreur possible avant ?... ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue sur le serveur", }; return StatusCode(500, erreurDTO); } return Ok(collaborateurs); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(long?)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } /// /// /// /// Récupérer la liste des référents des précédents EP du collaborateur. /// Id du collaborateur /// 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/collaborateurs/{idCollaborateur}/ep/referents")] [Authorize(AuthenticationSchemes = BearerAuthenticationHandler.SchemeName)] [ValidateModelState] [SwaggerOperation("GetReferentsPrecedentEPCollaborateur")] [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: 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 GetReferentsPrecedentEPCollaborateur([FromRoute][Required]Guid? idCollaborateur) { IEnumerable referents = null; try { referents = await collaborateurService.GetReferentsPrecedentsEPAsync(idCollaborateur); } catch (CollaborateurNotFoundException e) { ErreurDTO erreur = new ErreurDTO() { Code = 404, Message = e.Message }; return NotFound(erreur); } catch (ApiException e) { logger.LogError(e.Message); ErreurDTO erreur = new ErreurDTO() { Code = 500, Message = "Une erreur est survenue lors de la récupération des données collaborateurs" }; return StatusCode(500, erreur); } catch (Exception e) { logger.LogError(e.Message); //TODO : vérifier des cas d'erreur possible avant ?... ErreurDTO erreurDTO = new ErreurDTO() { Code = 500, Message = "Une erreur interne est survenue sur le serveur", }; return StatusCode(500, erreurDTO); } return Ok(referents); //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(200, default(List)); //TODO: Uncomment the next line to return response 401 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(401, default(ErreurDTO)); //TODO: Uncomment the next line to return response 403 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(403, default(ErreurDTO)); //TODO: Uncomment the next line to return response 404 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(404, default(ErreurDTO)); //TODO: Uncomment the next line to return response 500 or use other options such as return this.NotFound(), return this.BadRequest(..), ... // return StatusCode(500, default(ErreurDTO)); } } }