Referência à classe WebAPI.Controllers.AssistanceTypeController

Controller de Bolsa de Assistência. Mais...

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

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

Membros públicos
	AssistanceTypeController (IGetAssistanceTypeById getById, IGetAssistanceTypes getAll, ICreateAssistanceType create, IUpdateAssistanceType update, IDeleteAssistanceType delete, ILogger< AssistanceTypeController > logger)
	Construtor do Controller de Bolsa de Assistência. Mais...
async Task< IActionResult >	GetById (Guid? id)
	Busca bolsa de assistência pelo id. Mais...
async Task< ActionResult< IEnumerable< ResumedReadAssistanceTypeOutput > > >	GetAll (int skip=0, int take=50)
	Busca todas as bolsas de assitência ativas. Mais...
async Task< IActionResult >	Create ([FromBody] CreateAssistanceTypeInput request)
	Cria bolsa de assistência. Mais...
async Task< IActionResult >	Update (Guid? id, [FromBody] UpdateAssistanceTypeInput request)
	Atualiza bolsa de assistência. Mais...
async Task< IActionResult >	Delete (Guid? id)
	Remove bolsa de assistência. Mais...

Descrição detalhada

Controller de Bolsa de Assistência.

Documentação dos Construtores & Destrutor

AssistanceTypeController()

WebAPI.Controllers.AssistanceTypeController.AssistanceTypeController ( IGetAssistanceTypeById  getById, IGetAssistanceTypes  getAll, ICreateAssistanceType  create, IUpdateAssistanceType  update, IDeleteAssistanceType  delete, ILogger< AssistanceTypeController >  logger  )

inline

Construtor do Controller de Bolsa de Assistência.

Parâmetros

getById	Serviço de obtenção de bolsa de assistência pelo id.
getAll	Serviço de obtenção de todas as bolsas de assistência ativas.
create	Serviço de criação de bolsa de assistência.
update	Serviço de atualização de bolsa de assistência.
delete	Serviço de remoção de bolsa de assistência.
logger	Serviço de log.

Documentação dos métodos

Create()

async Task<IActionResult> WebAPI.Controllers.AssistanceTypeController.Create ( [FromBody] CreateAssistanceTypeInput  request )

inline

Cria bolsa de assistência.

Retorna

Bolsa de Assistência criada

<response code="201">Retorna bolsa de assistência 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<IActionResult> WebAPI.Controllers.AssistanceTypeController.Delete ( Guid?  id )

inline

Remove bolsa de assistência.

Retorna

Bolsa de Assistência removido

<response code="200">Retorna bolsa de assistência removido</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response>

GetAll()

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

inline

Busca todas as bolsas de assitência ativas.

Retorna

Todas as bolsas de assitência ativas

<response code="200">Retorna todas as bolsas de assitência ativas</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhuma bolsa de assitência encontrada.</response>

GetById()

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

inline

Busca bolsa de assistência pelo id.

Retorna

Bolsa de Assistência correspondente

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

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

Update()

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

inline

Atualiza bolsa de assistência.

Retorna

Bolsa de Assistência atualizada

<response code="200">Retorna bolsa de assistência 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/AssistanceTypeController.cs