Table of Contents

Class NotificationGlobalTemplatesController

Namespace
KadicErp.WebApi.Controllers.Notifications
Assembly
KadicErp.WebApi.dll
[ApiController]
[Authorize]
[Route("api/notifications/global-templates")]
[Produces("application/json", new string[] { })]
public class NotificationGlobalTemplatesController : ControllerBase
Inheritance
object
ControllerBase
NotificationGlobalTemplatesController

Constructors

NotificationGlobalTemplatesController(IMediator, IStringLocalizer<GeneralMessages>)

public NotificationGlobalTemplatesController(IMediator mediator, IStringLocalizer<GeneralMessages> localizer)

Parameters

mediator IMediator
localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid, CancellationToken)

[HttpPost("{id:guid}/activate")]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_ACTIVATE")]
[ProducesResponseType(204)]
public Task<ActionResult> Activate(Guid id, CancellationToken cancellationToken)

Parameters

id Guid
cancellationToken CancellationToken

Returns

Task<ActionResult>

Create(CreateGlobalTemplateCommand, CancellationToken)

[HttpPost]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_CREATE")]
[ProducesResponseType(typeof(object), 201)]
[ProducesResponseType(400)]
public Task<ActionResult> Create(CreateGlobalTemplateCommand command, CancellationToken cancellationToken)

Parameters

command CreateGlobalTemplateCommand
cancellationToken CancellationToken

Returns

Task<ActionResult>

Deactivate(Guid, CancellationToken)

[HttpPost("{id:guid}/deactivate")]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_DEACTIVATE")]
[ProducesResponseType(204)]
public Task<ActionResult> Deactivate(Guid id, CancellationToken cancellationToken)

Parameters

id Guid
cancellationToken CancellationToken

Returns

Task<ActionResult>

Delete(Guid, CancellationToken)

[HttpDelete("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_DELETE")]
[ProducesResponseType(204)]
[ProducesResponseType(404)]
public Task<ActionResult> Delete(Guid id, CancellationToken cancellationToken)

Parameters

id Guid
cancellationToken CancellationToken

Returns

Task<ActionResult>

GetAll(PaginatorRequestDto, CancellationToken)

[HttpGet]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<GlobalTemplateListItemDto>), 200)]
public Task<ActionResult<PaginatorResponseDto<GlobalTemplateListItemDto>>> GetAll(PaginatorRequestDto paginatorRequest, CancellationToken cancellationToken)

Parameters

paginatorRequest PaginatorRequestDto
cancellationToken CancellationToken

Returns

Task<ActionResult<PaginatorResponseDto<GlobalTemplateListItemDto>>>

GetById(Guid, CancellationToken)

[HttpGet("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_VIEW")]
[ProducesResponseType(typeof(GlobalTemplateDto), 200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<ActionResult<GlobalTemplateDto>> GetById(Guid id, CancellationToken cancellationToken)

Parameters

id Guid
cancellationToken CancellationToken

Returns

Task<ActionResult<GlobalTemplateDto>>

Update(Guid, UpdateGlobalTemplateRequest, CancellationToken)

[HttpPut("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_GLOBAL_TEMPLATES_UPDATE")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
public Task<ActionResult> Update(Guid id, UpdateGlobalTemplateRequest request, CancellationToken cancellationToken)

Parameters

id Guid
request UpdateGlobalTemplateRequest
cancellationToken CancellationToken

Returns

Task<ActionResult>