Table of Contents

Class EngagementsController

Namespace
KadicErp.WebApi.Controllers.Workforce
Assembly
KadicErp.WebApi.dll
[Route("api/workforce/engagements")]
[ApiController]
[Authorize]
[RequireModule("WORKFORCE")]
public class EngagementsController : ControllerBase
Inheritance
object
ControllerBase
EngagementsController

Constructors

EngagementsController(IMediator, IStringLocalizer<GeneralMessages>)

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

Parameters

mediator IMediator
localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid, CancellationToken)

[HttpPost("{id:guid}/activate")]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_ACTIVATE")]
public Task<IActionResult> Activate(Guid id, CancellationToken ct)

Parameters

id Guid
ct CancellationToken

Returns

Task<IActionResult>

Cancel(Guid, CancellationToken)

[HttpPost("{id:guid}/cancel")]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_CANCEL")]
public Task<IActionResult> Cancel(Guid id, CancellationToken ct)

Parameters

id Guid
ct CancellationToken

Returns

Task<IActionResult>

Complete(Guid, CancellationToken)

[HttpPost("{id:guid}/complete")]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_COMPLETE")]
public Task<IActionResult> Complete(Guid id, CancellationToken ct)

Parameters

id Guid
ct CancellationToken

Returns

Task<IActionResult>

Create(CreateEngagementCommand, CancellationToken)

[HttpPost]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_CREATE")]
public Task<IActionResult> Create(CreateEngagementCommand command, CancellationToken ct)

Parameters

command CreateEngagementCommand
ct CancellationToken

Returns

Task<IActionResult>

GetById(Guid, CancellationToken)

[HttpGet("{id:guid}")]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_VIEW")]
[ProducesResponseType(200)]
[ProducesResponseType(404)]
public Task<IActionResult> GetById(Guid id, CancellationToken ct)

Parameters

id Guid
ct CancellationToken

Returns

Task<IActionResult>

GetList(int, int, Guid?, EngagementStatus?, Guid?, DateTime?, DateTime?, CancellationToken)

[HttpGet]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_VIEW")]
public Task<IActionResult> GetList(int pageNumber = 1, int pageSize = 20, Guid? contractorId = null, EngagementStatus? status = null, Guid? clientBusinessPartnerId = null, DateTime? activeFrom = null, DateTime? activeTo = null, CancellationToken ct = default)

Parameters

pageNumber int
pageSize int
contractorId Guid?
status EngagementStatus?
clientBusinessPartnerId Guid?
activeFrom DateTime?
activeTo DateTime?
ct CancellationToken

Returns

Task<IActionResult>

Update(Guid, UpdateEngagementCommand, CancellationToken)

[HttpPut("{id:guid}")]
[Authorize(Policy = "WORKFORCE_ENGAGEMENTS_UPDATE")]
public Task<IActionResult> Update(Guid id, UpdateEngagementCommand command, CancellationToken ct)

Parameters

id Guid
command UpdateEngagementCommand
ct CancellationToken

Returns

Task<IActionResult>