Referência à classe WebAPI.Controllers.ProgramTypeController

Controller de Tipo de Programa. Mais...

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

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

Membros públicos
	ProgramTypeController (IGetProgramTypeById getById, IGetProgramTypes getAll, ICreateProgramType create, IUpdateProgramType update, IDeleteProgramType delete, ILogger< ProgramTypeController > logger)
	Construtor do Controller de Tipo de Programa. Mais...
async Task< ActionResult< DetailedReadProgramTypeOutput > >	GetById (Guid? id)
	Busca tipo de programa pelo id. Mais...
async Task< ActionResult< IEnumerable< ResumedReadProgramTypeOutput > > >	GetAll (int skip=0, int take=50)
	Busca todas os tipos de programas ativos. Mais...
async Task< ActionResult< DetailedReadProgramTypeOutput > >	Create ([FromBody] CreateProgramTypeInput request)
	Cria tipo de programa. Mais...
async Task< ActionResult< DetailedReadProgramTypeOutput > >	Update (Guid? id, [FromBody] UpdateProgramTypeInput request)
	Atualiza tipo de programa. Mais...
async Task< ActionResult< DetailedReadProgramTypeOutput > >	Delete (Guid? id)
	Remove tipo de programa. Mais...

Descrição detalhada

Controller de Tipo de Programa.

Documentação dos Construtores & Destrutor

ProgramTypeController()

WebAPI.Controllers.ProgramTypeController.ProgramTypeController ( IGetProgramTypeById  getById, IGetProgramTypes  getAll, ICreateProgramType  create, IUpdateProgramType  update, IDeleteProgramType  delete, ILogger< ProgramTypeController >  logger  )

inline

Construtor do Controller de Tipo de Programa.

Parâmetros

getById	Serviço de obtenção de tipo de programa pelo id.
getAll	Serviço de obtenção de todos os tipos de programas ativos.
create	Serviço de criação de tipo de programa.
update	Serviço de atualização de tipo de programa.
delete	Serviço de remoção de tipo de programa.
logger	Serviço de log.

Documentação dos métodos

Create()

async Task<ActionResult<DetailedReadProgramTypeOutput> > WebAPI.Controllers.ProgramTypeController.Create ( [FromBody] CreateProgramTypeInput  request )

inline

Cria tipo de programa.

Retorna

Tipo de Programa criado

<response code="201">Retorna tipo de programa criado</response> <response code="400">Requisição incorreta.</response>

Grafo de chamadas desta função:

Delete()

async Task<ActionResult<DetailedReadProgramTypeOutput> > WebAPI.Controllers.ProgramTypeController.Delete ( Guid?  id )

inline

Remove tipo de programa.

Retorna

Tipo de Programa removido

<response code="200">Retorna tipo de programa removido</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Tipo de Programa não encontrado.</response>

GetAll()

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

inline

Busca todas os tipos de programas ativos.

Retorna

Todas os tipos de programas ativos

<response code="200">Retorna todas os tipos de programas ativos</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum tipo de programa encontrado.</response>

GetById()

async Task<ActionResult<DetailedReadProgramTypeOutput> > WebAPI.Controllers.ProgramTypeController.GetById ( Guid?  id )

inline

Busca tipo de programa pelo id.

Retorna

Tipo de Programa correspondente

<response code="200">Retorna Tipo de Programa correspondente</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Tipo de Programa não encontrado.</response>

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

Update()

async Task<ActionResult<DetailedReadProgramTypeOutput> > WebAPI.Controllers.ProgramTypeController.Update ( Guid?  id, [FromBody] UpdateProgramTypeInput  request  )

inline

Atualiza tipo de programa.

Retorna

Tipo de Programa atualizado

<response code="200">Retorna tipo de programa atualizado</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Tipo de Programa não encontrado.</response>

---

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

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