Referência à classe WebAPI.Controllers.StudentDocumentsController

Controller de Documentos de Estudante. Mais...

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

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

Membros públicos
	StudentDocumentsController (IGetStudentDocumentsByProjectId getStudentDocumentsByProjectId, IGetStudentDocumentsByStudentId getStudentDocumentsByStudentId, ICreateStudentDocuments createStudentDocuments, IUpdateStudentDocuments updateStudentDocuments, IDeleteStudentDocuments deleteStudentDocuments, ILogger< StudentDocumentsController > logger)
	Construtor do Controller de Documentos de Estudante. Mais...
async Task< ActionResult< DetailedReadStudentDocumentsOutput > >	GetByProjectId (Guid? projectId)
	Busca documentos de estudante pelo id do projeto. Mais...
async Task< ActionResult< DetailedReadStudentDocumentsOutput > >	GetByStudentId (Guid? studentId)
	Busca documentos de estudante pelo id do estudante. Mais...
async Task< ActionResult< DetailedReadStudentDocumentsOutput > >	Create ([FromBody] CreateStudentDocumentsInput request)
	Adiciona documentos de estudante ao projeto. Mais...
async Task< ActionResult< DetailedReadStudentDocumentsOutput > >	Update (Guid? id, [FromBody] UpdateStudentDocumentsInput request)
	Atualiza documentos de estudante. Mais...
async Task< ActionResult< DetailedReadStudentDocumentsOutput > >	Delete (Guid? id)
	Remove documentos de estudante. Mais...

Descrição detalhada

Controller de Documentos de Estudante.

Documentação dos Construtores & Destrutor

StudentDocumentsController()

WebAPI.Controllers.StudentDocumentsController.StudentDocumentsController ( IGetStudentDocumentsByProjectId  getStudentDocumentsByProjectId, IGetStudentDocumentsByStudentId  getStudentDocumentsByStudentId, ICreateStudentDocuments  createStudentDocuments, IUpdateStudentDocuments  updateStudentDocuments, IDeleteStudentDocuments  deleteStudentDocuments, ILogger< StudentDocumentsController >  logger  )

inline

Construtor do Controller de Documentos de Estudante.

Parâmetros

getStudentDocumentsByProjectId	Use Case de busca de documentos de estudante pelo id do projeto.
getStudentDocumentsByStudentId	Use Case de busca de documentos de estudante pelo id do estudante.
createStudentDocuments	Use Case de adição de documentos de estudante.
updateStudentDocuments	Use Case de atualização de documentos de estudante.
deleteStudentDocuments	Use Case de remoção de documentos de estudante.
logger	Logger

Documentação dos métodos

Create()

async Task<ActionResult<DetailedReadStudentDocumentsOutput> > WebAPI.Controllers.StudentDocumentsController.Create ( [FromBody] CreateStudentDocumentsInput  request )

inline

Adiciona documentos de estudante ao projeto.

Parâmetros

request

Dados para adição dos documentos.

<response code="201">Documentos de estudante adicionados.</response> <response code="400">O id informado não pode ser nulo.</response> <response code="401">Usuário não autenticado.</response>

Grafo de chamadas desta função:

Delete()

async Task<ActionResult<DetailedReadStudentDocumentsOutput> > WebAPI.Controllers.StudentDocumentsController.Delete ( Guid?  id )

inline

Remove documentos de estudante.

Parâmetros

id	Id dos documentos do estudante

<response code="200">Documentos de estudante removidos.</response> <response code="400">O id informado não pode ser nulo.</response> <response code="401">Usuário não autenticado.</response> <response code="404">Documentos de estudante não encontrados.</response>

GetByProjectId()

async Task<ActionResult<DetailedReadStudentDocumentsOutput> > WebAPI.Controllers.StudentDocumentsController.GetByProjectId ( Guid?  projectId )

inline

Busca documentos de estudante pelo id do projeto.

Parâmetros

projectId

Id do projeto

<response code="200">Documentos de estudante encontrados.</response> <response code="400">O id informado não pode ser nulo.</response> <response code="401">Usuário não autenticado.</response> <response code="404">Documentos de estudante não encontrados.</response>

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

GetByStudentId()

async Task<ActionResult<DetailedReadStudentDocumentsOutput> > WebAPI.Controllers.StudentDocumentsController.GetByStudentId ( Guid?  studentId )

inline

Busca documentos de estudante pelo id do estudante.

Parâmetros

studentId

Id do estudante

<response code="200">Documentos de estudante encontrados.</response> <response code="400">O id informado não pode ser nulo.</response> <response code="401">Usuário não autenticado.</response> <response code="404">Documentos de estudante não encontrados.</response>

Update()

async Task<ActionResult<DetailedReadStudentDocumentsOutput> > WebAPI.Controllers.StudentDocumentsController.Update ( Guid?  id, [FromBody] UpdateStudentDocumentsInput  request  )

inline

Atualiza documentos de estudante.

Parâmetros

id	Id dos documentos do estudante
request	Dados para atualização dos documentos.

<response code="200">Documentos de estudante atualizados.</response> <response code="400">O id informado não pode ser nulo.</response> <response code="401">Usuário não autenticado.</response> <response code="404">Documentos de estudante não encontrados.</response>

---

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

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