Table of Contents

Class MaritalStatusController

Namespace
KadicErp.WebApi.Controllers.ReferenceData
Assembly
KadicErp.WebApi.dll
[Route("api/MaritalStatuses")]
[Authorize]
public class MaritalStatusController : GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>
Inheritance
object
ControllerBase
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>
MaritalStatusController
Inherited Members
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.Sender
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.CreateGetByIdQuery(Guid)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.CreateGetAllQuery(PaginatorRequestDto, bool?)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.SetCommandId(UpdateMaritalStatusCommand, Guid)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.HandleCommandResult(Result)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.HandleCommandResult<T>(Result<T>, string)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.Create(CreateMaritalStatusCommand)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.Update(Guid, UpdateMaritalStatusCommand)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.GetById(Guid)
GenericCrudControllerBase<MaritalStatusDto, CreateMaritalStatusCommand, UpdateMaritalStatusCommand, GetMaritalStatusByIdQuery, GetAllMaritalStatusesQuery>.GetAll(PaginatorRequestDto, bool?)

Constructors

MaritalStatusController(ISender, IStringLocalizer<GeneralMessages>) 

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

Parameters

sender ISender
localizer IStringLocalizer<GeneralMessages>

Methods

Activate(Guid) 

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

Parameters

id Guid

Returns

Task<IActionResult>

Create(CreateMaritalStatusCommand)

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

Parameters

command CreateMaritalStatusCommand

Returns

Task<IActionResult>

Deactivate(Guid) 

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

Parameters

id Guid

Returns

Task<IActionResult>

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

Parameters

command UpdateMaritalStatusCommand
id Guid

Returns

UpdateMaritalStatusCommand

Update(Guid, UpdateMaritalStatusCommand)

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

Parameters

id Guid
command UpdateMaritalStatusCommand

Returns

Task<IActionResult>
Edit this page