Class BranchesController

Namespace

KadicErp.WebApi.Controllers.ReferenceData

Assembly

KadicErp.WebApi.dll

[Route("api/[controller]")]
[Authorize]
public class BranchesController : GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>

Inheritance

object

ControllerBase

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>

BranchesController

Inherited Members

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.Sender

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.CreateGetByIdQuery(Guid)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.CreateGetAllQuery(PaginatorRequestDto, bool?)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.SetCommandId(UpdateBranchCommand, Guid)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.HandleCommandResult(Result)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.HandleCommandResult<T>(Result<T>, string)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.Create(CreateBranchCommand)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.Update(Guid, UpdateBranchCommand)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.GetById(Guid)

GenericCrudControllerBase<BranchDto, CreateBranchCommand, UpdateBranchCommand, GetBranchByIdQuery, GetAllBranchesQuery>.GetAll(PaginatorRequestDto, bool?)

Constructors

BranchesController(ISender, IStringLocalizer<GeneralMessages>)

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

Parameters

sender ISender

localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid)

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

Parameters

id Guid

Returns

Task<IActionResult>

Create(CreateBranchCommand)

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_BRANCHES_CREATE")]
[ProducesResponseType(typeof(Result<Guid>), 201)]
[ProducesResponseType(typeof(Result), 400)]
[ProducesResponseType(typeof(Result), 409)]
public override Task<IActionResult> Create(CreateBranchCommand command)

Parameters

command CreateBranchCommand

Returns

Task<IActionResult>

Deactivate(Guid)

[HttpPatch("{id}/deactivate")]
[Authorize(Policy = "REFERENCE_DATA_BRANCHES_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_BRANCHES_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<BranchDto>), 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_BRANCHES_VIEW")]
[ProducesResponseType(typeof(BranchDto), 200)]
[ProducesResponseType(typeof(Error), 404)]
public override Task<IActionResult> GetById(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

SetCommandId(UpdateBranchCommand, 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 UpdateBranchCommand SetCommandId(UpdateBranchCommand command, Guid id)

Parameters

command UpdateBranchCommand

id Guid

Returns

UpdateBranchCommand

Update(Guid, UpdateBranchCommand)

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_BRANCHES_UPDATE")]
[ProducesResponseType(typeof(Result), 200)]
[ProducesResponseType(typeof(Result), 400)]
[ProducesResponseType(typeof(Result), 404)]
[ProducesResponseType(typeof(Result), 409)]
public override Task<IActionResult> Update(Guid id, UpdateBranchCommand command)

Parameters

id Guid

command UpdateBranchCommand

Returns

Task<IActionResult>