Class PositionsController

Namespace

KadicErp.WebApi.Controllers.ReferenceData

Assembly

KadicErp.WebApi.dll

Positions controller - Uses Generic CRUD Controller Pattern Inherits from GenericCrudControllerBase to reuse common CRUD endpoints

[Route("api/[controller]")]
[Authorize]
public class PositionsController : GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>

Inheritance

object

ControllerBase

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>

PositionsController

Inherited Members

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.Sender

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.CreateGetByIdQuery(Guid)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.CreateGetAllQuery(PaginatorRequestDto, bool?)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.SetCommandId(UpdatePositionCommand, Guid)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.HandleCommandResult(Result)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.HandleCommandResult<T>(Result<T>, string)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.Create(CreatePositionCommand)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.Update(Guid, UpdatePositionCommand)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.GetById(Guid)

GenericCrudControllerBase<PositionDto, CreatePositionCommand, UpdatePositionCommand, GetPositionByIdQuery, GetAllPositionsQuery>.GetAll(PaginatorRequestDto, bool?)

Constructors

PositionsController(ISender, IStringLocalizer<GeneralMessages>)

Positions controller - Uses Generic CRUD Controller Pattern Inherits from GenericCrudControllerBase to reuse common CRUD endpoints

public PositionsController(ISender sender, IStringLocalizer<GeneralMessages> localizer)

Parameters

sender ISender

localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid)

[HttpPatch("{id}/activate")]
[Authorize(Policy = "REFERENCE_DATA_POSITIONS_ACTIVATE")]
public Task<IActionResult> Activate(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

Create(CreatePositionCommand)

POST endpoint for creating a new entity. Returns 201 Created with Location header on success.

IMPORTANT: Override in derived class to add [HttpPost] and [Authorize(Policy = ...)]

[HttpPost]
[Authorize(Policy = "REFERENCE_DATA_POSITIONS_CREATE")]
[ProducesResponseType(typeof(Result<Guid>), 201)]
[ProducesResponseType(typeof(Result), 400)]
[ProducesResponseType(typeof(Result), 409)]
public override Task<IActionResult> Create(CreatePositionCommand command)

Parameters

command CreatePositionCommand

Returns

Task<IActionResult>

Deactivate(Guid)

[HttpPatch("{id}/deactivate")]
[Authorize(Policy = "REFERENCE_DATA_POSITIONS_DEACTIVATE")]
public Task<IActionResult> Deactivate(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

GetAll(PaginatorRequestDto, bool?)

GET endpoint for retrieving paginated list of entities. Supports optional isActive filter.

IMPORTANT: Override in derived class to add [HttpGet] and [Authorize(Policy = ...)] Override CreateGetAllQuery if you need additional filters. Note: ProducesResponseType attributes cannot be added here due to generic type parameters. Add them in derived class if needed for Swagger documentation.

[HttpGet]
[Authorize(Policy = "REFERENCE_DATA_POSITIONS_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<PositionDto>), 200)]
[ProducesResponseType(typeof(Error), 400)]
public override Task<IActionResult> GetAll(PaginatorRequestDto paginator, bool? isActive = null)

Parameters

paginator PaginatorRequestDto

isActive bool?

Returns

Task<IActionResult>

GetById(Guid)

GET endpoint for retrieving a single entity by ID. Returns 404 Not Found if entity doesn't exist.

IMPORTANT: Override in derived class to add [HttpGet("{id}")] and [Authorize(Policy = ...)] Note: ProducesResponseType attributes cannot be added here due to generic type parameters. Add them in derived class if needed for Swagger documentation.

[HttpGet("{id}")]
[Authorize(Policy = "REFERENCE_DATA_POSITIONS_VIEW")]
[ProducesResponseType(typeof(PositionDto), 200)]
[ProducesResponseType(typeof(Error), 404)]
public override Task<IActionResult> GetById(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

SetCommandId(UpdatePositionCommand, Guid)

Updates the command with the ID from route. This method must be overridden in derived classes to properly set the Id.

For record types with 'with' expression, use:

protected override UpdateXCommand SetCommandId(UpdateXCommand command, Guid id)
    => command with { Id = id };

protected override UpdatePositionCommand SetCommandId(UpdatePositionCommand command, Guid id)

Parameters

command UpdatePositionCommand

id Guid

Returns

UpdatePositionCommand

Update(Guid, UpdatePositionCommand)

PUT endpoint for updating an existing entity. Returns 200 OK on success.

IMPORTANT: Override in derived class to add [HttpPut("{id}")] and [Authorize(Policy = ...)]

[HttpPut("{id}")]
[Authorize(Policy = "REFERENCE_DATA_POSITIONS_UPDATE")]
[ProducesResponseType(typeof(Result), 200)]
[ProducesResponseType(typeof(Result), 400)]
[ProducesResponseType(typeof(Result), 404)]
[ProducesResponseType(typeof(Result), 409)]
public override Task<IActionResult> Update(Guid id, UpdatePositionCommand command)

Parameters

id Guid

command UpdatePositionCommand

Returns

Task<IActionResult>