Table of Contents

Class OccupationsController

Namespace
KadicErp.WebApi.Controllers.ReferenceData
Assembly
KadicErp.WebApi.dll

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

[Route("api/[controller]")]
[Authorize]
public class OccupationsController : GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>
Inheritance
object
ControllerBase
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>
OccupationsController
Inherited Members
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.Sender
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.CreateGetByIdQuery(Guid)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.CreateGetAllQuery(PaginatorRequestDto, bool?)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.SetCommandId(UpdateOccupationCommand, Guid)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.HandleCommandResult(Result)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.HandleCommandResult<T>(Result<T>, string)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.Create(CreateOccupationCommand)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.Update(Guid, UpdateOccupationCommand)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.GetById(Guid)
GenericCrudControllerBase<OccupationDto, CreateOccupationCommand, UpdateOccupationCommand, GetOccupationByIdQuery, GetAllOccupationsQuery>.GetAll(PaginatorRequestDto, bool?)

Constructors

OccupationsController(ISender, IStringLocalizer<GeneralMessages>)

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

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

Parameters

sender ISender
localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid) 

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

Parameters

id Guid

Returns

Task<IActionResult>

Create(CreateOccupationCommand)

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

Parameters

command CreateOccupationCommand

Returns

Task<IActionResult>

Deactivate(Guid) 

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

Parameters

id Guid

Returns

Task<IActionResult>

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

Parameters

command UpdateOccupationCommand
id Guid

Returns

UpdateOccupationCommand

Update(Guid, UpdateOccupationCommand)

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

Parameters

id Guid
command UpdateOccupationCommand

Returns

Task<IActionResult>
Edit this page