Class TemplatesController

Controller for template management API endpoints including email, process, and event templates.

Inheritance
object
ControllerBase
TemplatesController
Inherited Members
Namespace: OEMS.UI.Controllers
Assembly: OEMS.UI.dll
Syntax
[ApiController]
[Route("api/[controller]")]
[Authorize]
public class TemplatesController : ControllerBase

Constructors

TemplatesController(ITemplateService, IHttpContextAccessor)

Initializes a new instance of the TemplatesController class.

Declaration
public TemplatesController(ITemplateService templateService, IHttpContextAccessor httpContextAccessor)
Parameters
Type Name Description
ITemplateService templateService

The template service for template operations.
IHttpContextAccessor httpContextAccessor

The HTTP context accessor for accessing request context.

Methods

CreateEmailTemplate(CreateEmailTemplateDto)

Creates a new email template in the system.

Declaration
[HttpPost("email")]
public Task<ActionResult<Guid>> CreateEmailTemplate(CreateEmailTemplateDto dto)
Parameters
Type Name Description
CreateEmailTemplateDto dto

The data transfer object containing the email template information.
Returns
Type Description
Task<ActionResult<Guid>>

The unique identifier of the newly created email template.
Remarks

This method validates that all required fields are provided (Name, Subject, Body, OrganizationId). The current user must have appropriate permissions for the specified organization.

CreateProcessStepTemplate(CreateProcessStepTemplateDto)

Declaration
[HttpPost("processstep")]
public Task<ActionResult<Guid>> CreateProcessStepTemplate(CreateProcessStepTemplateDto dto)
Parameters
Type Name Description
CreateProcessStepTemplateDto dto
Returns
Type Description
Task<ActionResult<Guid>>

CreateProcessTemplate(CreateProcessTemplateDto)

Declaration
[HttpPost("process")]
public Task<ActionResult<Guid>> CreateProcessTemplate(CreateProcessTemplateDto dto)
Parameters
Type Name Description
CreateProcessTemplateDto dto
Returns
Type Description
Task<ActionResult<Guid>>

DeleteEmailTemplate(Guid)

Deletes an email template from the system.

Declaration
[HttpDelete("email/{id}")]
public Task<ActionResult> DeleteEmailTemplate(Guid id)
Parameters
Type Name Description
Guid id

The unique identifier of the email template to delete.
Returns
Type Description
Task<ActionResult>

No content response if the deletion is successful.
Remarks

The current user must have appropriate permissions for the organization that owns the template. Returns 404 Not Found if the template does not exist or the user lacks permissions to access it.

DeleteProcessStepTemplate(Guid)

Declaration
[HttpDelete("processstep/{id}")]
public Task<ActionResult> DeleteProcessStepTemplate(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<ActionResult>

DeleteProcessTemplate(Guid)

Declaration
[HttpDelete("process/{id}")]
public Task<ActionResult> DeleteProcessTemplate(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<ActionResult>

GetEmailTemplate(Guid)

Retrieves a specific email template by its unique identifier.

Declaration
[HttpGet("email/{id}")]
public Task<ActionResult<EmailTemplateDto>> GetEmailTemplate(Guid id)
Parameters
Type Name Description
Guid id

The unique identifier of the email template to retrieve.
Returns
Type Description
Task<ActionResult<EmailTemplateDto>>

The email template with the specified identifier if found.
Remarks

This method first attempts to find the template by its ID without organization filtering. If found, it validates that the current user has access to the template's organization. If direct access fails, it falls back to checking each organization the user has access to.

GetEmailTemplates(Guid)

Retrieves all email templates for a specific organization.

Declaration
[HttpGet("email/organization/{organizationId}")]
public Task<ActionResult<IEnumerable<EmailTemplateDto>>> GetEmailTemplates(Guid organizationId)
Parameters
Type Name Description
Guid organizationId

The unique identifier of the organization.
Returns
Type Description
Task<ActionResult<IEnumerable<EmailTemplateDto>>>

A collection of email templates associated with the specified organization.
Remarks

This method retrieves email templates that belong to the specified organization. The user must have appropriate permissions (OrgAdmin, Organizer, or Designer role) for the organization to access its templates.

GetEventTemplates(Guid)

Declaration
[HttpGet("event/organization/{organizationId}")]
public Task<ActionResult<IEnumerable<EventTemplateDto>>> GetEventTemplates(Guid organizationId)
Parameters
Type Name Description
Guid organizationId
Returns
Type Description
Task<ActionResult<IEnumerable<EventTemplateDto>>>

GetProcessStepTemplate(Guid)

Declaration
[HttpGet("processstep/{id}")]
public Task<ActionResult<ProcessStepTemplateDto>> GetProcessStepTemplate(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<ActionResult<ProcessStepTemplateDto>>

GetProcessStepTemplates(Guid)

Declaration
[HttpGet("processstep/template/{processTemplateId}")]
public Task<ActionResult<IEnumerable<ProcessStepTemplateDto>>> GetProcessStepTemplates(Guid processTemplateId)
Parameters
Type Name Description
Guid processTemplateId
Returns
Type Description
Task<ActionResult<IEnumerable<ProcessStepTemplateDto>>>

GetProcessTemplate(Guid)

Declaration
[HttpGet("process/{id}")]
public Task<ActionResult<ProcessTemplateDto>> GetProcessTemplate(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<ActionResult<ProcessTemplateDto>>

GetProcessTemplates(Guid)

Declaration
[HttpGet("process/organization/{organizationId}")]
public Task<ActionResult<IEnumerable<ProcessTemplateDto>>> GetProcessTemplates(Guid organizationId)
Parameters
Type Name Description
Guid organizationId
Returns
Type Description
Task<ActionResult<IEnumerable<ProcessTemplateDto>>>

UpdateEmailTemplate(UpdateEmailTemplateDto)

Updates an existing email template in the system.

Declaration
[HttpPut("email")]
public Task<ActionResult> UpdateEmailTemplate(UpdateEmailTemplateDto dto)
Parameters
Type Name Description
UpdateEmailTemplateDto dto

The data transfer object containing the updated email template information.
Returns
Type Description
Task<ActionResult>

No content response if the update is successful.
Remarks

This method validates that all required fields are provided (Id, Name, Subject, Body). The current user must have appropriate permissions for the organization that owns the template. Returns 404 Not Found if the template does not exist or the user lacks permissions to access it.

UpdateProcessStepTemplate(UpdateProcessStepTemplateDto)

Declaration
[HttpPut("processstep")]
public Task<ActionResult> UpdateProcessStepTemplate(UpdateProcessStepTemplateDto dto)
Parameters
Type Name Description
UpdateProcessStepTemplateDto dto
Returns
Type Description
Task<ActionResult>

UpdateProcessStepTemplateSequence(Guid, int)

Declaration
[HttpPut("processstep/{id}/sequence")]
public Task<ActionResult> UpdateProcessStepTemplateSequence(Guid id, int newSequence)
Parameters
Type Name Description
Guid id
int newSequence
Returns
Type Description
Task<ActionResult>

UpdateProcessTemplate(UpdateProcessTemplateDto)

Declaration
[HttpPut("process")]
public Task<ActionResult> UpdateProcessTemplate(UpdateProcessTemplateDto dto)
Parameters
Type Name Description
UpdateProcessTemplateDto dto
Returns
Type Description
Task<ActionResult>