Referência à classe WebAPI.Controllers.NoticeController

Controller de Edital. Mais...

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

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

Membros públicos
	NoticeController (IGetNoticeById getById, IGetNotices getAll, ICreateNotice create, IUpdateNotice update, IDeleteNotice delete, ILogger< NoticeController > logger)
	Construtor do Controller de Edital. Mais...
async Task< ActionResult< DetailedReadNoticeOutput > >	GetById (Guid? id)
	Busca edital pelo id. Mais...
async Task< ActionResult< IEnumerable< ResumedReadNoticeOutput > > >	GetAll (int skip=0, int take=50)
	Busca todas os editais ativos. Mais...
async Task< ActionResult< DetailedReadNoticeOutput > >	Create ([FromForm] CreateNoticeInput request)
	Cria edital. Mais...
async Task< ActionResult< DetailedReadNoticeOutput > >	Update (Guid? id, [FromForm] UpdateNoticeInput request)
	Atualiza edital. Mais...
async Task< ActionResult< DetailedReadNoticeOutput > >	Delete (Guid? id)
	Remove edital. Mais...

Descrição detalhada

Controller de Edital.

Documentação dos Construtores & Destrutor

NoticeController()

WebAPI.Controllers.NoticeController.NoticeController ( IGetNoticeById  getById, IGetNotices  getAll, ICreateNotice  create, IUpdateNotice  update, IDeleteNotice  delete, ILogger< NoticeController >  logger  )

inline

Construtor do Controller de Edital.

Parâmetros

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

Documentação dos métodos

Create()

async Task<ActionResult<DetailedReadNoticeOutput> > WebAPI.Controllers.NoticeController.Create ( [FromForm] CreateNoticeInput  request )

inline

Cria edital.

Retorna

Edital criado

<response code="201">Retorna edital criado</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<ActionResult<DetailedReadNoticeOutput> > WebAPI.Controllers.NoticeController.Delete ( Guid?  id )

inline

Remove edital.

Retorna

Edital removido

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

GetAll()

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

inline

Busca todas os editais ativos.

Retorna

Todas os editais ativos

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

GetById()

async Task<ActionResult<DetailedReadNoticeOutput> > WebAPI.Controllers.NoticeController.GetById ( Guid?  id )

inline

Busca edital pelo id.

Retorna

Edital correspondente

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

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

Update()

async Task<ActionResult<DetailedReadNoticeOutput> > WebAPI.Controllers.NoticeController.Update ( Guid?  id, [FromForm] UpdateNoticeInput  request  )

inline

Atualiza edital.

Retorna

Edital atualizado

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

---

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

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