Class BusinessPartnersController

Namespace

KadicErp.WebApi.Controllers.BusinessPartners

Assembly

KadicErp.WebApi.dll

[ApiController]
[Route("api/business-partners")]
[Authorize]
[RequireModule("BUSINESS_PARTNERS")]
public class BusinessPartnersController : ControllerBase

Inheritance

object

ControllerBase

BusinessPartnersController

Constructors

BusinessPartnersController(ISender)

public BusinessPartnersController(ISender sender)

Parameters

sender ISender

Methods

Activate(Guid)

[HttpPatch("{id}/activate")]
[Authorize(Policy = "BUSINESS_PARTNERS_ACTIVATE")]
[ProducesResponseType(200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<IActionResult> Activate(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

CreateExpressOrganization(CreateBusinessPartnerExpressOrganizationCommand)

[HttpPost("organizations/express")]
[Authorize(Policy = "BUSINESS_PARTNERS_CREATE")]
[ProducesResponseType(typeof(Guid), 201)]
[ProducesResponseType(typeof(Error), 400)]
[ProducesResponseType(typeof(Error), 409)]
public Task<IActionResult> CreateExpressOrganization(CreateBusinessPartnerExpressOrganizationCommand command)

Parameters

command CreateBusinessPartnerExpressOrganizationCommand

Returns

Task<IActionResult>

CreateExpressPerson(CreateBusinessPartnerExpressPersonCommand)

[HttpPost("persons/express")]
[Authorize(Policy = "BUSINESS_PARTNERS_CREATE")]
[ProducesResponseType(typeof(Guid), 201)]
[ProducesResponseType(typeof(Error), 400)]
[ProducesResponseType(typeof(Error), 409)]
public Task<IActionResult> CreateExpressPerson(CreateBusinessPartnerExpressPersonCommand command)

Parameters

command CreateBusinessPartnerExpressPersonCommand

Returns

Task<IActionResult>

CreateOrganization(CreateBusinessPartnerOrganizationCommand)

[HttpPost("organizations")]
[Authorize(Policy = "BUSINESS_PARTNERS_CREATE")]
[ProducesResponseType(typeof(Guid), 201)]
[ProducesResponseType(typeof(Error), 400)]
[ProducesResponseType(typeof(Error), 409)]
public Task<IActionResult> CreateOrganization(CreateBusinessPartnerOrganizationCommand command)

Parameters

command CreateBusinessPartnerOrganizationCommand

Returns

Task<IActionResult>

CreatePerson(CreateBusinessPartnerPersonCommand)

[HttpPost("persons")]
[Authorize(Policy = "BUSINESS_PARTNERS_CREATE")]
[ProducesResponseType(typeof(Guid), 201)]
[ProducesResponseType(typeof(Error), 400)]
[ProducesResponseType(typeof(Error), 409)]
public Task<IActionResult> CreatePerson(CreateBusinessPartnerPersonCommand command)

Parameters

command CreateBusinessPartnerPersonCommand

Returns

Task<IActionResult>

Deactivate(Guid)

[HttpPatch("{id}/deactivate")]
[Authorize(Policy = "BUSINESS_PARTNERS_DEACTIVATE")]
[ProducesResponseType(200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<IActionResult> Deactivate(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

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

[HttpGet]
[Authorize(Policy = "BUSINESS_PARTNERS_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<BusinessPartnerSummaryDto>), 200)]
public Task<ActionResult<PaginatorResponseDto<BusinessPartnerSummaryDto>>> GetAll(PaginatorRequestDto paginator, string? searchTerm, Guid? profileId, string? profileCode, bool? isActive, Guid? countryId, Guid? partnerTypeId)

Parameters

paginator PaginatorRequestDto

searchTerm string

profileId Guid?

profileCode string

isActive bool?

countryId Guid?

partnerTypeId Guid?

Returns

Task<ActionResult<PaginatorResponseDto<BusinessPartnerSummaryDto>>>

GetAllOrganizations(PaginatorRequestDto, string?)

[HttpGet("organizations")]
[Authorize(Policy = "BUSINESS_PARTNERS_ORGANIZATIONS_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<BusinessPartnerOrganizationDto>), 200)]
public Task<ActionResult<PaginatorResponseDto<BusinessPartnerOrganizationDto>>> GetAllOrganizations(PaginatorRequestDto paginator, string? searchTerm)

Parameters

paginator PaginatorRequestDto

searchTerm string

Returns

Task<ActionResult<PaginatorResponseDto<BusinessPartnerOrganizationDto>>>

GetAllPersons(PaginatorRequestDto, string?)

[HttpGet("persons")]
[Authorize(Policy = "BUSINESS_PARTNERS_PERSONS_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<BusinessPartnerPersonDto>), 200)]
public Task<ActionResult<PaginatorResponseDto<BusinessPartnerPersonDto>>> GetAllPersons(PaginatorRequestDto paginator, string? searchTerm)

Parameters

paginator PaginatorRequestDto

searchTerm string

Returns

Task<ActionResult<PaginatorResponseDto<BusinessPartnerPersonDto>>>

GetById(Guid)

[HttpGet("detail-by/{id}")]
[Authorize(Policy = "BUSINESS_PARTNERS_VIEW")]
[ProducesResponseType(typeof(BusinessPartnerDetailDto), 200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<ActionResult<BusinessPartnerDetailDto>> GetById(Guid id)

Parameters

id Guid

Returns

Task<ActionResult<BusinessPartnerDetailDto>>

UpdateOrganization(Guid, UpdateBusinessPartnerOrganizationCommand)

[HttpPut("organizations/{id}")]
[Authorize(Policy = "BUSINESS_PARTNERS_UPDATE")]
[ProducesResponseType(typeof(Result<string>), 200)]
[ProducesResponseType(typeof(Error), 400)]
[ProducesResponseType(typeof(Error), 404)]
public Task<IActionResult> UpdateOrganization(Guid id, UpdateBusinessPartnerOrganizationCommand command)

Parameters

id Guid

command UpdateBusinessPartnerOrganizationCommand

Returns

Task<IActionResult>

UpdatePerson(Guid, UpdateBusinessPartnerPersonCommand)

[HttpPut("persons/{id}")]
[Authorize(Policy = "BUSINESS_PARTNERS_UPDATE")]
[ProducesResponseType(typeof(Result<string>), 200)]
[ProducesResponseType(typeof(Error), 400)]
[ProducesResponseType(typeof(Error), 404)]
public Task<IActionResult> UpdatePerson(Guid id, UpdateBusinessPartnerPersonCommand command)

Parameters

id Guid

command UpdateBusinessPartnerPersonCommand

Returns

Task<IActionResult>