|
|
|
## Rotas RESTful API
|
|
|
|
|
|
|
|
### Resource: activity
|
|
|
|
* [X] __RFA01:__ GET /activities (_PRIORIZED_)
|
|
|
|
|
|
|
|
**Objetivo:** Obtém todas as atividades cadastradas.
|
|
|
|
|
|
|
|
**Entrada:** Não há.
|
|
|
|
|
|
|
|
**Saída:** [get-activities.out.json](/uploads/71593b8d5ffa0fcce0e61c955b25d28f/get-activities.out.json)
|
|
|
|
|
|
|
|
* [X] __RFA02:__ GET /activities/:activityId
|
|
|
|
|
|
|
|
* [ ] __RFA03:__ POST /activities
|
|
|
|
|
|
|
|
* [ ] __RFA04:__ PUT /activities/:activityId
|
|
|
|
|
|
|
|
* [ ] __RFA05:__ DELETE /activities/:activityId
|
|
|
|
|
|
|
|
### Resource: activity_punctuation
|
|
|
|
* [ ] __RFP01:__ GET /activity_punctuations
|
|
|
|
|
|
|
|
* [ ] __RFP02:__ GET /activity_punctuations/:activity_punctuationId
|
|
|
|
|
|
|
|
* [ ] __RFP03:__ POST /activity_punctuations
|
|
|
|
|
|
|
|
* [ ] __RFP04:__ PUT /activity_punctuations/:activity_punctuationId
|
|
|
|
|
|
|
|
* [ ] __RFP05:__ DELETE /activity_punctuations/:activity_punctuationId
|
|
|
|
|
|
|
|
### Resource: researcher
|
|
|
|
* [ ] __RFR01:__ GET /researchers
|
|
|
|
|
|
|
|
* [ ] __RFR02:__ GET /researchers/:researcherId
|
|
|
|
|
|
|
|
* [ ] __RFR03:__ POST /researchers
|
|
|
|
|
|
|
|
* [ ] __RFR04:__ PUT /researchers/:researcherId
|
|
|
|
|
|
|
|
* [ ] __RFR05:__ DELETE /researchers/:researcherId
|
|
|
|
|
|
|
|
### Resource: interview
|
|
|
|
* [ ] __RFI01:__ GET /interviews
|
|
|
|
|
|
|
|
* [ ] __RFI02:__ GET /interviews/:interviewId
|
|
|
|
|
|
|
|
* [ ] __RFI03:__ GET /interviews/results/:interviewId (_PRIORIZED_)
|
|
|
|
|
|
|
|
**Objetivo:** Obter todos os resultados de uma entrevista
|
|
|
|
|
|
|
|
**Entrada:** Id da entrevista por parâmetro.
|
|
|
|
|
|
|
|
**Saída:** [get-interviews-results.out.json](/uploads/f9f6366810e636e458ce9667af13dfa5/get-interviews-results.out.json)
|
|
|
|
|
|
|
|
* [ ] __RFI04:__ POST /interviews (_PRIORIZED_)
|
|
|
|
|
|
|
|
**Objetivo:** Criar um registro uma entrevista e o esqueleto de uma agenda sem semanas.
|
|
|
|
|
|
|
|
**Entrada:** [post-interviews.in.json](/uploads/8681458c272ba57faf9f75ec4dd71d5b/post-interviews.in.json)
|
|
|
|
|
|
|
|
**Saída:** [post-interviews.out.json](/uploads/8c2fd54650764742d809878ce58e9f92/post-interviews.out.json)
|
|
|
|
|
|
|
|
* [ ] __RFI05:__ PUT /interviews/:interviewId
|
|
|
|
|
|
|
|
* [ ] __RFI06:__ DELETE /interviews/:interviewId
|
|
|
|
|
|
|
|
### Resource: schedule
|
|
|
|
* [ ] __RFC01:__ GET /schedules
|
|
|
|
|
|
|
|
* [ ] __RFC02:__ GET /schedules/:scheduleId
|
|
|
|
|
|
|
|
* [ ] __RFC03:__ POST /schedules
|
|
|
|
|
|
|
|
* [ ] __RFC04:__ PUT /schedules/:scheduleId
|
|
|
|
|
|
|
|
* [ ] __RFC05:__ DELETE /schedules/:scheduleId
|
|
|
|
|
|
|
|
### Resource: week
|
|
|
|
* [ ] __RFW01:__ GET /weeks
|
|
|
|
|
|
|
|
* [ ] __RFW02:__ GET /weeks/:weekId
|
|
|
|
|
|
|
|
* [ ] __RFW03:__ POST /weeks (_PRIORIZED_)
|
|
|
|
|
|
|
|
**Objetivo:** Cadastrar uma semana com seus sete dias, onde cada dia terá suas vinte e quatro horas.
|
|
|
|
|
|
|
|
**Entrada:** [post-weeks.in.json](/uploads/9a92cddc8143c178a9a4282c57b98bae/post-weeks.in.json)
|
|
|
|
|
|
|
|
**Saída:** [post-weeks.out.json](/uploads/5c0d58a8b12c9de89b6c2b4e4abe5cf3/post-weeks.out.json)
|
|
|
|
|
|
|
|
* [ ] __RFW04:__ PUT /weeks/:weekId
|
|
|
|
|
|
|
|
* [ ] __RFW05:__ DELETE /weeks/:weekId
|
|
|
|
|
|
|
|
### Resource: day
|
|
|
|
* [ ] __RFD01:__ GET /days
|
|
|
|
|
|
|
|
* [ ] __RFD02:__ GET /days/:dayId
|
|
|
|
|
|
|
|
* [ ] __RFD03:__ POST /days
|
|
|
|
|
|
|
|
* [ ] __RFD04:__ PUT /days/:dayId
|
|
|
|
|
|
|
|
* [ ] __RFD05:__ DELETE /days/:dayId
|
|
|
|
|
|
|
|
### Resource: question
|
|
|
|
* [ ] __RFQ01:__ GET /questions
|
|
|
|
|
|
|
|
* [ ] __RFQ02:__ GET /questions/:questionId
|
|
|
|
|
|
|
|
* [ ] __RFQ03:__ POST /questions (_PRIORIZED_)
|
|
|
|
|
|
|
|
**Objetivo:** Cadastrar a pergunta e resposta do entrevistado a um evento.
|
|
|
|
|
|
|
|
**Entrada:** [post-questions.in.json](/uploads/990cd6983fd63abb7032562f48a082d2/post-questions.in.json)
|
|
|
|
|
|
|
|
**Saída:** [post-questions.out.json](/uploads/b4e604015cfe4673b16868ddaa3559c7/post-questions.out.json)
|
|
|
|
|
|
|
|
* [ ] __RFQ04:__ PUT /questions/:questionId
|
|
|
|
|
|
|
|
* [ ] __RFQ05:__ DELETE /questions/:questionId
|
|
|
|
|
|
|
|
### Resource: hour
|
|
|
|
* [ ] __RFH01:__ GET /hours
|
|
|
|
|
|
|
|
* [ ] __RFH02:__ GET /hours/:hourId
|
|
|
|
|
|
|
|
* [ ] __RFH03:__ POST /hours
|
|
|
|
|
|
|
|
* [ ] __RFH04:__ PUT /hours/:hourId
|
|
|
|
|
|
|
|
* [ ] __RFH05:__ DELETE /hours/:hourId
|
|
|
|
|
|
|
|
### Resource: result
|
|
|
|
* [ ] __RFE01:__ GET /results
|
|
|
|
|
|
|
|
* [ ] __RFE02:__ GET /results/:resultId
|
|
|
|
|
|
|
|
* [ ] __RFE03:__ POST /results
|
|
|
|
|
|
|
|
* [ ] __RFE04:__ PUT /results/:resultId
|
|
|
|
|
|
|
|
* [ ] __RFE05:__ DELETE /results/:resultId
|
|
|
|
|
|
|
|
### Resource: event
|
|
|
|
* [ ] __RFV01:__ GET /events (_PRIORIZED_)
|
|
|
|
|
|
|
|
**Objetivo:** Obter todos os eventos cadastrados.
|
|
|
|
|
|
|
|
**Entrada:** Não há.
|
|
|
|
|
|
|
|
**Saída:** [get-events.out.json](/uploads/9a949d87c8531e28153ee3c94bf14030/get-events.out.json)
|
|
|
|
|
|
|
|
* [ ] __RFV02:__ GET /events/:eventId
|
|
|
|
|
|
|
|
* [ ] __RFV03:__ POST /events
|
|
|
|
|
|
|
|
* [ ] __RFV04:__ PUT /events/:eventId
|
|
|
|
|
|
|
|
* [ ] __RFV05:__ DELETE /events/:eventId
|
|
|
|
|
|
|
|
Formato de apresentação obtido através de `[Adoções - Requisitos API](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/wikis/requisitos-api)` |
|
|
|
\ No newline at end of file |