Referência à classe WebAPI.Controllers.SubAreaController

Controller de Sub Área. Mais...

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

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

Membros públicos
	SubAreaController (IGetSubAreaById getSubAreaById, IGetSubAreasByArea getSubAreasByArea, ICreateSubArea createSubArea, IUpdateSubArea updateSubArea, IDeleteSubArea deleteSubArea, ILogger< SubAreaController > logger)
	Construtor do Controller de Sub Área. Mais...
async Task< ActionResult< DetailedReadSubAreaOutput > >	GetById (Guid? id)
	Obtém sub área pelo id. Mais...
async Task< ActionResult< IEnumerable< ResumedReadSubAreaOutput > > >	GetSubAreasByArea (Guid? areaId, int skip=0, int take=50)
	Obtém todas as sub áreas ativas da área. Mais...
async Task< ActionResult< DetailedReadSubAreaOutput > >	Create ([FromBody] CreateSubAreaInput request)
	Cria sub área. Mais...
async Task< ActionResult< DetailedReadSubAreaOutput > >	Update (Guid? id, [FromBody] UpdateSubAreaInput request)
	Atualiza sub área. Mais...
async Task< ActionResult< DetailedReadSubAreaOutput > >	Delete (Guid? id)
	Remove sub área. Mais...

Descrição detalhada

Controller de Sub Área.

Documentação dos Construtores & Destrutor

SubAreaController()

WebAPI.Controllers.SubAreaController.SubAreaController ( IGetSubAreaById  getSubAreaById, IGetSubAreasByArea  getSubAreasByArea, ICreateSubArea  createSubArea, IUpdateSubArea  updateSubArea, IDeleteSubArea  deleteSubArea, ILogger< SubAreaController >  logger  )

inline

Construtor do Controller de Sub Área.

Parâmetros

getSubAreaById	Obtém sub área pelo id.
getSubAreasByArea	Obtém todas as sub áreas ativas da área.
createSubArea	Cria sub área.
updateSubArea	Atualiza sub área.
deleteSubArea	Remove sub área.
logger	Logger.

Documentação dos métodos

Create()

async Task<ActionResult<DetailedReadSubAreaOutput> > WebAPI.Controllers.SubAreaController.Create ( [FromBody] CreateSubAreaInput  request )

inline

Cria sub área.

Parâmetros

request

Dados da sub área.

Retorna

Sub área criada.

<response code="201">Sub área criada.</response> <response code="400">Dados da sub área inválidos.</response> <response code="401">Usuário não autorizado.</response>

Grafo de chamadas desta função:

Delete()

async Task<ActionResult<DetailedReadSubAreaOutput> > WebAPI.Controllers.SubAreaController.Delete ( Guid?  id )

inline

Remove sub área.

Parâmetros

id	Id da sub área.

Retorna

Sub área removida.

<response code="200">Sub área removida.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Sub área não encontrada.</response>

GetById()

async Task<ActionResult<DetailedReadSubAreaOutput> > WebAPI.Controllers.SubAreaController.GetById ( Guid?  id )

inline

Obtém sub área pelo id.

Parâmetros

id	Id da sub área.

Retorna

Sub área.

<response code="200">Sub área encontrada.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Sub área não encontrada.</response>

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

GetSubAreasByArea()

async Task<ActionResult<IEnumerable<ResumedReadSubAreaOutput> > > WebAPI.Controllers.SubAreaController.GetSubAreasByArea ( Guid?  areaId, int  skip = 0, int  take = 50  )

inline

Obtém todas as sub áreas ativas da área.

Parâmetros

areaId	Id da área.
skip	Quantidade de registros a serem ignorados.
take	Quantidade de registros a serem retornados.

Retorna

Sub áreas.

<response code="200">Sub áreas encontradas.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Sub áreas não encontradas.</response>

Update()

async Task<ActionResult<DetailedReadSubAreaOutput> > WebAPI.Controllers.SubAreaController.Update ( Guid?  id, [FromBody] UpdateSubAreaInput  request  )

inline

Atualiza sub área.

Parâmetros

id	Id da sub área.
request	Dados da sub área.

Retorna

Sub área atualizada.

<response code="200">Sub área atualizada.</response> <response code="400">Dados da sub área inválidos.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Sub área não encontrada.</response>

---

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

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