Referência à classe WebAPI.Controllers.MainAreaController

Controller de Área Principal. Mais...

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

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

Membros públicos
	MainAreaController (IGetMainAreaById getById, IGetMainAreas getAll, ICreateMainArea create, IUpdateMainArea update, IDeleteMainArea delete, ILogger< MainAreaController > logger)
	Construtor do Controller de Área Principal. Mais...
async Task< ActionResult< DetailedMainAreaOutput > >	GetById (Guid? id)
	Busca área principal pelo id. Mais...
async Task< ActionResult< IEnumerable< ResumedReadMainAreaOutput > > >	GetAll (int skip=0, int take=50)
	Busca todas as áreas principais ativas. Mais...
async Task< ActionResult< DetailedMainAreaOutput > >	Create ([FromBody] CreateMainAreaInput request)
	Cria área principal. Mais...
async Task< ActionResult< DetailedMainAreaOutput > >	Update (Guid? id, [FromBody] UpdateMainAreaInput request)
	Atualiza área principal. Mais...
async Task< ActionResult< DetailedMainAreaOutput > >	Delete (Guid? id)
	Remove área principal. Mais...

Descrição detalhada

Controller de Área Principal.

Documentação dos Construtores & Destrutor

MainAreaController()

WebAPI.Controllers.MainAreaController.MainAreaController ( IGetMainAreaById  getById, IGetMainAreas  getAll, ICreateMainArea  create, IUpdateMainArea  update, IDeleteMainArea  delete, ILogger< MainAreaController >  logger  )

inline

Construtor do Controller de Área Principal.

Parâmetros

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

Documentação dos métodos

Create()

async Task<ActionResult<DetailedMainAreaOutput> > WebAPI.Controllers.MainAreaController.Create ( [FromBody] CreateMainAreaInput  request )

inline

Cria área principal.

Retorna

Área principal criada

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

Grafo de chamadas desta função:

Delete()

async Task<ActionResult<DetailedMainAreaOutput> > WebAPI.Controllers.MainAreaController.Delete ( Guid?  id )

inline

Remove área principal.

Retorna

Área principal removida

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

GetAll()

async Task<ActionResult<IEnumerable<ResumedReadMainAreaOutput> > > WebAPI.Controllers.MainAreaController.GetAll ( int  skip = 0, int  take = 50  )

inline

Busca todas as áreas principais ativas.

Retorna

Todas as áreas principais ativas

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

GetById()

async Task<ActionResult<DetailedMainAreaOutput> > WebAPI.Controllers.MainAreaController.GetById ( Guid?  id )

inline

Busca área principal pelo id.

Retorna

Área principal correspondente

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

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

Update()

async Task<ActionResult<DetailedMainAreaOutput> > WebAPI.Controllers.MainAreaController.Update ( Guid?  id, [FromBody] UpdateMainAreaInput  request  )

inline

Atualiza área principal.

Retorna

Área principal atualizada

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

---

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

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