Referência à classe WebAPI.Controllers.CampusController

Controller de Campus. Mais...

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

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

Membros públicos
	CampusController (IGetCampusById getById, IGetCampuses getAll, ICreateCampus create, IUpdateCampus update, IDeleteCampus delete, ILogger< CampusController > logger)
	Construtor do Controller de Campus. Mais...
async Task< ActionResult< DetailedReadCampusOutput > >	GetById (Guid? id)
	Busca campus pelo id. Mais...
async Task< ActionResult< IEnumerable< ResumedReadCampusOutput > > >	GetAll (int skip=0, int take=50)
	Busca todas os campus ativos. Mais...
async Task< ActionResult< DetailedReadCampusOutput > >	Create ([FromBody] CreateCampusInput request)
	Cria um novo campus. Mais...
async Task< ActionResult< DetailedReadCampusOutput > >	Update (Guid? id, [FromBody] UpdateCampusInput request)
	Atualiza um campus. Mais...
async Task< ActionResult< DetailedReadCampusOutput > >	Remover (Guid? id)
	Remove um campus. Mais...

Descrição detalhada

Controller de Campus.

Documentação dos Construtores & Destrutor

CampusController()

WebAPI.Controllers.CampusController.CampusController ( IGetCampusById  getById, IGetCampuses  getAll, ICreateCampus  create, IUpdateCampus  update, IDeleteCampus  delete, ILogger< CampusController >  logger  )

inline

Construtor do Controller de Campus.

Parâmetros

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

Documentação dos métodos

Create()

async Task<ActionResult<DetailedReadCampusOutput> > WebAPI.Controllers.CampusController.Create ( [FromBody] CreateCampusInput  request )

inline

Cria um novo campus.

Parâmetros

request

Informações do campus

Retorna

O campus criado

<response code="201">Retorna o campus recém-criado</response> <response code="400">Requisição inválida, se a entrada for inválida</response> <response code="401">Não autorizado, se o usuário não tiver a função necessária</response>

Grafo de chamadas desta função:

GetAll()

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

inline

Busca todas os campus ativos.

Retorna

Todas os campus ativos

<response code="200">Retorna todas os campus ativos</response> <response code="400">Requisição incorreta.</response> <response code="404">Nenhum Campus encontrado.</response>

GetById()

async Task<ActionResult<DetailedReadCampusOutput> > WebAPI.Controllers.CampusController.GetById ( Guid?  id )

inline

Busca campus pelo id.

Retorna

Campus correspondente

<response code="200">Retorna campus correspondente</response> <response code="400">Requisição incorreta.</response> <response code="404">Campus não encontrado.</response>

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

Remover()

async Task<ActionResult<DetailedReadCampusOutput> > WebAPI.Controllers.CampusController.Remover ( Guid?  id )

inline

Remove um campus.

Parâmetros

id	O ID do campus a ser removido

Retorna

O campus removido

<response code="200">Retorna o campus removido</response> <response code="400">Requisição inválida, se o ID for nulo</response> <response code="401">Não autorizado, se o usuário não tiver a função necessária</response> <response code="404">Não encontrado, se o campus não existir</response>

Update()

async Task<ActionResult<DetailedReadCampusOutput> > WebAPI.Controllers.CampusController.Update ( Guid?  id, [FromBody] UpdateCampusInput  request  )

inline

Atualiza um campus.

Parâmetros

id	O ID do campus a ser atualizado
request	Informações de atualização do campus

Retorna

O campus atualizado

<response code="200">Retorna o campus atualizado</response> <response code="400">Requisição inválida, se a entrada for inválida</response> <response code="401">Não autorizado, se o usuário não tiver a função necessária</response> <response code="404">Não encontrado, se o campus não existir</response>

---

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

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