|
|
|
# ATENÇÃO:
|
|
|
|
## NECESSÁRIO ESTAR COM O BANCO DE DADOS E O PROJETO DE AUTENTICAÇÃO RODANDO
|
|
|
|
<br>
|
|
|
|
# # ARQUIVOS POSTMAN:
|
|
|
|
Download disponível no [repositório 9. rotas api](http://www.tools.ages.pucrs.br/EasyWork/Wiki/tree/master/9.%20rotas%20api).
|
|
|
|
|
|
|
|
# Arquivos postman:
|
|
|
|
[DOWNLOAD ARQUIVOS POSTMAN](http://www.tools.ages.pucrs.br/EasyWork/Wiki/tree/master/9.%20rotas%20api)
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# # API BACK-AUTH-SERVICE
|
|
|
|
## `ATENÇÃO: NECESSÁRIO ESTAR COM O BANCO DE DADOS E O PROJETO DE AUTENTICAÇÃO (auth-api) RODANDO`
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# CADASTRO
|
|
|
|
## CADASTRO
|
|
|
|
#### POST em [url]/api/auth/signup
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>, <b>ROLE_RESPONDENT</b>, <b>ROLE_ADMIN</b>)
|
|
|
|
<br>
|
| ... | ... | @@ -24,7 +25,7 @@ |
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# LOGIN
|
|
|
|
## LOGIN
|
|
|
|
#### POST em [url]/api/auth/signin
|
|
|
|
(para o login pode-se usar tanto o username quanto o email cadastrado)
|
|
|
|
<br>
|
| ... | ... | @@ -38,19 +39,21 @@ |
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# Usando o TOKEN
|
|
|
|
## Usando o TOKEN
|
|
|
|
#### Exemplo: GET em [url]/api/roles
|
|
|
|
(Necessário usar um header de <b>Authorization</b> com valor <b>Bearer + token</b>, conforme imagem abaixo)
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# ATENÇÃO:
|
|
|
|
## NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (back-auth-api) E O PROJETO DE PESQUISAS (back-research-api) RODANDO
|
|
|
|
# # API BACK-RESEARCH-SERVICE
|
|
|
|
## `ATENÇÃO: NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (auth-api) E O PROJETO DE PESQUISAS (research-api) RODANDO`
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# CADASTRO DE PESQUISA
|
|
|
|
## CADASTRO DE PESQUISA
|
|
|
|
#### POST em [url]/api/researches
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
|
|
|
|
|
| ... | ... | @@ -72,14 +75,14 @@ |
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# OBTENDO PESQUISA
|
|
|
|
## OBTENDO PESQUISA
|
|
|
|
#### GET em [url]/api/researches/{idResearch}
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# ATUALIZANDO PESQUISA
|
|
|
|
## ATUALIZANDO PESQUISA
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
|
|
|
|
<br>
|
|
|
|
#### PUT em [url]/api/researches/{idResearch}
|
| ... | ... | @@ -87,54 +90,56 @@ |
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
# EXCLUINDO PESQUISA
|
|
|
|
## EXCLUINDO PESQUISA
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>, <b>ROLE_ADMIN</b>)
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
#### DELETE em [url]/api/researches/{idResearch}
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# OBTENDO PESQUISAS DO PESQUISADOR LOGADO
|
|
|
|
## Necessário usar a autenticação de um Pesquisador (ROLE_RESEARCHER)
|
|
|
|
## OBTENDO PESQUISAS DO PESQUISADOR LOGADO
|
|
|
|
### Necessário usar a autenticação de um Pesquisador (ROLE_RESEARCHER)
|
|
|
|
#### GET em [url]/api/researches/myresearches
|
|
|
|
#### GET em [url]/api/researches/myresearches/{status}
|
|
|
|
|
|
|
|
# ATENÇÃO: `EM CONSTRUÇÃO`
|
|
|
|
## NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (back-auth-api), O PROJETO DE PESQUISAS (back-research-api) E O PROJETO DE RESPOSTAS (back-response-api) RODANDO
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# # API BACK-RESPONSE-SERVICE
|
|
|
|
## `ATENÇÃO: NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (auth-api), O PROJETO DE PESQUISAS (research-api) E O PROJETO DE RESPOSTAS (response-api) RODANDO`
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# CADASTRO DE RESPOSTA PARA UMA PESQUISA
|
|
|
|
## CADASTRO DE RESPOSTA PARA UMA PESQUISA
|
|
|
|
#### POST em [url]/api/responses/respondent/start/{researchId}
|
|
|
|
(possíveis ROLES: <b>ROLE_RESPONDENT</b>)
|
|
|
|
<br>
|
|
|
|
#### É iniciado período de resposta do respondente (ver no GET abaixo campos createdAt e status preenchidos)
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# OBTER DE RESPOSTAS DE UMA PESQUISA
|
|
|
|
## OBTER RESPOSTAS DE UMA PESQUISA
|
|
|
|
#### GET em [url]/api/responses/research/{researchId}
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# FINALIZAR UMA RESPOSTA PARA UMA PESQUISA
|
|
|
|
## FINALIZAR UMA RESPOSTA PARA UMA PESQUISA
|
|
|
|
|
|
|
|
#### PUT em [url]/api/responses/respondent/start/{researchId}
|
|
|
|
#### PUT em [url]/api/responses/respondent/finish/{researchId}
|
|
|
|
(possíveis ROLES: <b>ROLE_RESPONDENT</b>)
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
#### É finalizado período de resposta do respondente (preenchido campo respondedAt e alterado campo status para RESPONDIDO)
|
|
|
|
#### É finalizado período de resposta do respondente (preenchido campo respondedAt e alterado campo status para PENDING)
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br> |
|
|
\ No newline at end of file |
