Referência à classe WebAPI.Controllers.StudentController

Controller de Estudante. Mais...

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

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

Membros públicos
	StudentController (IGetStudentById getStudentById, IGetStudentByRegistrationCode getStudentByRegistrationCode, IGetStudents getAllStudents, ICreateStudent createStudent, IUpdateStudent updateStudent, IDeleteStudent deleteStudent, IRequestStudentRegister requestStudentRegister, ILogger< StudentController > logger)
	Construtor do Controller de Estudante. Mais...
async Task< ActionResult< DetailedReadStudentOutput > >	GetById (Guid? id)
	Busca Estudante pelo id. Mais...
async Task< ActionResult< DetailedReadStudentOutput > >	GetByRegistrationCode (string? registrationCode)
	Busca Estudante pelo id. Mais...
async Task< ActionResult< string > >	RequestStudentRegister (string? email)
	Solicita registro de Estudante através do e-mail. Mais...
async Task< ActionResult< IEnumerable< ResumedReadStudentOutput > > >	GetAll (int skip=0, int take=50)
	Busca todas os Estudante ativos. Mais...
async Task< ActionResult< DetailedReadStudentOutput > >	Create ([FromBody] CreateStudentInput request)
	Cria Estudante. Mais...
async Task< ActionResult< DetailedReadStudentOutput > >	Update (Guid? id, [FromBody] UpdateStudentInput request)
	Atualiza Estudante. Mais...
async Task< ActionResult< DetailedReadStudentOutput > >	Delete (Guid? id)
	Remove Estudante. Mais...

Descrição detalhada

Controller de Estudante.

Documentação dos Construtores & Destrutor

StudentController()

WebAPI.Controllers.StudentController.StudentController ( IGetStudentById  getStudentById, IGetStudentByRegistrationCode  getStudentByRegistrationCode, IGetStudents  getAllStudents, ICreateStudent  createStudent, IUpdateStudent  updateStudent, IDeleteStudent  deleteStudent, IRequestStudentRegister  requestStudentRegister, ILogger< StudentController >  logger  )

inline

Construtor do Controller de Estudante.

Parâmetros

getStudentById	Obtém Estudante pelo id
getStudentByRegistrationCode	Obtém Estudante pela matrícula
getAllStudents	Obtém todos os Estudantes
createStudent	Cria Estudante
updateStudent	Atualiza Estudante
deleteStudent	Remove Estudante
requestStudentRegister	Solicita registro de Estudante
logger	Logger

Documentação dos métodos

Create()

async Task<ActionResult<DetailedReadStudentOutput> > WebAPI.Controllers.StudentController.Create ( [FromBody] CreateStudentInput  request )

inline

Cria Estudante.

Retorna

Estudante criado

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

Grafo de chamadas desta função:

Delete()

async Task<ActionResult<DetailedReadStudentOutput> > WebAPI.Controllers.StudentController.Delete ( Guid?  id )

inline

Remove Estudante.

Retorna

Estudante removido

<response code="200">Retorna Estudante removido</response> <response code="400">Retorna mensagem de erro</response> <response code="401">Retorna mensagem de erro</response> <response code="404">Retorna mensagem de erro</response>

GetAll()

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

inline

Busca todas os Estudante ativos.

Retorna

Todas os Estudante ativos

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

GetById()

async Task<ActionResult<DetailedReadStudentOutput> > WebAPI.Controllers.StudentController.GetById ( Guid?  id )

inline

Busca Estudante pelo id.

Retorna

Estudante correspondente

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

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

GetByRegistrationCode()

async Task<ActionResult<DetailedReadStudentOutput> > WebAPI.Controllers.StudentController.GetByRegistrationCode ( string?  registrationCode )

inline

Busca Estudante pelo id.

Retorna

Estudante correspondente

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

RequestStudentRegister()

async Task<ActionResult<string> > WebAPI.Controllers.StudentController.RequestStudentRegister ( string?  email )

inline

Solicita registro de Estudante através do e-mail.

Parâmetros

email

E-mail do estudante

Retorna

Informa se o envio do e-mail foi bem sucedido

<response code="200">E-mail enviado com sucesso</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="500">Ocorreu um erro ao solicitar o registro do estudante.</response>

Update()

async Task<ActionResult<DetailedReadStudentOutput> > WebAPI.Controllers.StudentController.Update ( Guid?  id, [FromBody] UpdateStudentInput  request  )

inline

Atualiza Estudante.

Retorna

Estudante atualizado

<response code="200">Retorna Estudante atualizado</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum Estudante encontrado.</response>

---

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

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