|
|
|
# ATENÇÃO:
|
|
|
|
## NECESSÁRIO ESTAR COM O BANCO DE DADOS E O PROJETO DE AUTENTICAÇÃO RODANDO
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# CADASTRO
|
|
|
|
#### POST em [url]/api/auth/signup
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>, <b>ROLE_RESPONDENT</b>, <b>ROLE_ADMIN</b>)
|
|
|
|
<br>
|
|
|
|
```{
|
|
|
|
"name":"Diego Osmarin Basso",
|
|
|
|
"username":"dob",
|
|
|
|
"email":"dob@dob",
|
|
|
|
"password":"dobdob",
|
|
|
|
"role":"ROLE_ADMIN"
|
|
|
|
}```
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# LOGIN
|
|
|
|
#### POST em [url]/api/auth/signin
|
|
|
|
(para o login pode-se usar tanto o username quanto o email cadastrado)
|
|
|
|
<br>
|
|
|
|
```{
|
|
|
|
"login":"dob",
|
|
|
|
"password":"dobdob"
|
|
|
|
}```
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# 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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# CADASTRO DE PESQUISA
|
|
|
|
#### POST em [url]/api/researches
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
|
|
|
|
<br>
|
|
|
|
```{
|
|
|
|
"name": "Pesquisa 3",
|
|
|
|
"description": "Descrição 3",
|
|
|
|
"link": "www.link3.com",
|
|
|
|
"numRespondents": 21,
|
|
|
|
"maximumResponseTime": 15,
|
|
|
|
"estimatedResponseTime": 15,
|
|
|
|
"payAmount": 1.35,
|
|
|
|
"endDate": "2020-11-11T11:20:00Z"
|
|
|
|
}```
|
|
|
|
|
|
|
|
#### No header é retornada o endereço da pesquisa cadastrada
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# OBTENDO PESQUISA
|
|
|
|
#### GET em [url]/api/researches/{idResearch}
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
# ATUALIZANDO PESQUISA
|
|
|
|
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
|
|
|
|
<br>
|
|
|
|
#### PUT em [url]/api/researches/{idResearch}
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
# 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)
|
|
|
|
#### 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>
|
|
|
|
|
|
|
|
# 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
|
|
|
|
#### GET em [url]/api/responses/research/{researchId}
|
|
|
|
<br>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
# FINALIZAR UMA RESPOSTA PARA UMA PESQUISA
|
|
|
|
#### PUT em [url]/api/responses/respondent/start/{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)
|
|
|
|
<br>
|
|
|
|
 |
