Class ItemsController

Namespace

KadicErp.WebApi.Controllers.Catalog

Assembly

KadicErp.WebApi.dll

[Route("api/[controller]")]
[Authorize]
public class ItemsController : GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>

Inheritance

object

ControllerBase

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>

ItemsController

Inherited Members

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.Sender

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.CreateGetByIdQuery(Guid)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.CreateGetAllQuery(PaginatorRequestDto, bool?)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.SetCommandId(UpdateItemCommand, Guid)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.HandleCommandResult(Result)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.HandleCommandResult<T>(Result<T>, string)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.Create(CreateItemCommand)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.Update(Guid, UpdateItemCommand)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.GetById(Guid)

GenericCrudControllerBase<ItemDto, CreateItemCommand, UpdateItemCommand, GetItemByIdQuery, GetAllItemsQuery>.GetAll(PaginatorRequestDto, bool?)

Constructors

ItemsController(ISender, ICurrentUser, ITenantIdContext, IStringLocalizer<GeneralMessages>)

public ItemsController(ISender sender, ICurrentUser currentUser, ITenantIdContext tenantContext, IStringLocalizer<GeneralMessages> localizer)

Parameters

sender ISender

currentUser ICurrentUser

tenantContext ITenantIdContext

localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid)

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

Parameters

id Guid

Returns

Task<IActionResult>

Create(CreateItemCommand)

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

Parameters

command CreateItemCommand

Returns

Task<IActionResult>

Deactivate(Guid)

[HttpPatch("{id}/deactivate")]
[Authorize(Policy = "CATALOG_ITEMS_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.

[NonAction]
public override Task<IActionResult> GetAll(PaginatorRequestDto paginator, bool? isActive = null)

Parameters

paginator PaginatorRequestDto

isActive bool?

Returns

Task<IActionResult>

GetAll(PaginatorRequestDto, bool?, Guid?, Guid?, string?, Guid?, Guid?, CancellationToken)

[HttpGet]
[Authorize(Policy = "CATALOG_ITEMS_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<ItemDto>), 200)]
[ProducesResponseType(typeof(Error), 400)]
public Task<IActionResult> GetAll(PaginatorRequestDto paginator, bool? isActive = null, Guid? categoryId = null, Guid? itemTypeId = null, string? searchTerm = null, Guid? warehouseId = null, Guid? targetCurrencyId = null, CancellationToken cancellationToken = default)

Parameters

paginator PaginatorRequestDto

isActive bool?

categoryId Guid?

itemTypeId Guid?

searchTerm string

warehouseId Guid?

targetCurrencyId Guid?

cancellationToken CancellationToken

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.

[NonAction]
public override Task<IActionResult> GetById(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

GetById(Guid, Guid?)

[HttpGet("{id}")]
[Authorize(Policy = "CATALOG_ITEMS_VIEW")]
[ProducesResponseType(typeof(ItemDto), 200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<IActionResult> GetById(Guid id, Guid? targetCurrencyId = null)

Parameters

id Guid

targetCurrencyId Guid?

Returns

Task<IActionResult>

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

Parameters

command UpdateItemCommand

id Guid

Returns

UpdateItemCommand

Update(Guid, UpdateItemCommand)

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

Parameters

id Guid

command UpdateItemCommand

Returns

Task<IActionResult>