Referência à classe WebAPI.Controllers.AreaController

Controller de Área. Mais...

Diagrama de heranças da classe WebAPI.Controllers.AreaController

Diagrama de colaboração para WebAPI.Controllers.AreaController:

Membros públicos
	AreaController (IGetAreaById getById, IGetAreasByMainArea getAreasByMainArea, ICreateArea create, IUpdateArea update, IDeleteArea delete, ILogger< AreaController > logger)
	Construtor do Controller de Área. Mais...
async Task< IActionResult >	GetById (Guid? id)
	Busca área pelo id. Mais...
async Task< IActionResult >	GetAreasByMainArea (Guid? mainAreaId, int skip=0, int take=50)
	Busca todas as áreas ativas pela área principal. Mais...
async Task< IActionResult >	Create ([FromBody] CreateAreaInput request)
	Cria área. Mais...
async Task< IActionResult >	Update (Guid? id, [FromBody] UpdateAreaInput request)
	Atualiza área. Mais...
async Task< IActionResult >	Delete (Guid? id)
	Remove área. Mais...

Descrição detalhada

Controller de Área.

Documentação dos Construtores & Destrutor

AreaController()

WebAPI.Controllers.AreaController.AreaController ( IGetAreaById  getById, IGetAreasByMainArea  getAreasByMainArea, ICreateArea  create, IUpdateArea  update, IDeleteArea  delete, ILogger< AreaController >  logger  )

inline

Construtor do Controller de Área.

Parâmetros

getById	Serviço de obtenção de área pelo id.
getAreasByMainArea	Serviço de obtenção de todas as áreas ativas da área principal.
create	Serviço de criação de área.
update	Serviço de atualização de área.
delete	Serviço de remoção de área.
logger	Serviço de log.

Documentação dos métodos

Create()

async Task<IActionResult> WebAPI.Controllers.AreaController.Create ( [FromBody] CreateAreaInput  request )

inline

Cria área.

Retorna

Área criada

<response code="201">Retorna área criada</response> <response code="400">Requisição incorreta.</response>

Grafo de chamadas desta função:

Delete()

async Task<IActionResult> WebAPI.Controllers.AreaController.Delete ( Guid?  id )

inline

Remove área.

Retorna

Área removida

<response code="200">Retorna área removida</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response>

GetAreasByMainArea()

async Task<IActionResult> WebAPI.Controllers.AreaController.GetAreasByMainArea ( Guid?  mainAreaId, int  skip = 0, int  take = 50  )

inline

Busca todas as áreas ativas pela área principal.

Retorna

Todas as áreas ativas da área principal

<response code="200">Retorna todas as áreas ativas da área principal</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhuma área encontrada.</response>

GetById()

async Task<IActionResult> WebAPI.Controllers.AreaController.GetById ( Guid?  id )

inline

Busca área pelo id.

Retorna

Área correspondente

<response code="200">Retorna área correspondente</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhuma área encontrada.</response>

Este é o diagrama das funções que utilizam esta função:

Update()

async Task<IActionResult> WebAPI.Controllers.AreaController.Update ( Guid?  id, [FromBody] UpdateAreaInput  request  )

inline

Atualiza área.

Retorna

Área atualizada

<response code="200">Retorna área atualizada</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response>

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• src/Infrastructure/WebAPI/Controllers/AreaController.cs