GitLab

Página de todas as rotas/endpoints que a API acessa.

Esta seção serve para auxiliar a quais rotas estão configuradas na API e qual o endereços para chamá-las. Estão todas categorizadas abaixo. Todas as execuções a seguir foram executadas em localhost. Deve-se se certificar que está no endereço de servidor correto caso seja testado em outro lugar. (ex: localhost::3009/signup, ages.pucrs.br/signup)

Legendas:

• route: Rota a ser digitada na barra de endereços.
• method: Método que deve ser chamado para busca (POST, GET, PATCH, DELETE...).
• body: Json que deve ser inserido na seção "body".

Voltar para a [página principal][princ] [princ]: /home

Inicialização:

• Cadastro de novo usuário: route: /signup | method: POST | body:{"username": String, "password": String, "name": String}

• Login de usuário: route: /login | method: GET | Headers: {"Authentication": "Basic" + base65(user : password) } | returns token

ESTA TOKEN DEVE SER INSERIDA NO HEADERS DE OUTRAS CHAMADAS QUE A NECESSITAM PARA QUE FUNCIONE

Usuário:

route: /profile | method: GET | Headers: {"x-access-token": [JWT TOKEN]) } [DEVE ESTAR AUTENTICADO]

route: /ocorrencias/{idOcorrencia} | method: GET | params: n/a | Headers: {"x-access-token": [JWT TOKEN]) } [DEVE ESTAR AUTENTICADO]

route: /ocorrencias | method: POST | params: n/a | Headers: {"x-access-token": [JWT TOKEN]) } [DEVE ESTAR AUTENTICADO]

route: /ocorrencias | method: GET | Headers: {"x-access-token": [JWT TOKEN]) } params: n/a | [DEVE ESTAR AUTENTICADO]

route: /ocorrencias/todas | method: GET | Headers: {"x-access-token": [JWT TOKEN]) } params: n/a | [DEVE ESTAR AUTENTICADO]

route: /usuarios | method: GET | Headers: no-auth

route: /dados_gerais/{idOcorrencia} | method: PATCH | params: { "numeroOcorrencia": String, "sedeOcorrencia": Sede._id, "peritosOcorrencia": [Peritos._id], "dataHoraAcionamento": dateTime } | Headers: {"x-access-token": [JWT TOKEN]) } [DEVE ESTAR AUTENTICADO]

route: /endereco/{idOcorrencia} | method: PATCH | params: { "tipoLocal": String, "estado": String, "municipio": String, "logradouro": String, "complemento": String, "_id": Ocorrencia._id } | Headers: {"x-access-token": [JWT TOKEN]) } [DEVE ESTAR AUTENTICADO]

route: /responsavel_local/{idOcorrencia} | method: PATCH | params: { "nomeResponsavel": String, "cargoResponsavel": String, "documentoResponsavel": String, "entrevistaResponsavel": String, "_id": Ocorrencia._id } | Headers: {"x-access-token": [JWT TOKEN]) } [DEVE ESTAR AUTENTICADO]

route: /popular_banco/default | method: GET | params: n/a | [DEVE ESTAR AUTENTICADO COM USERNAME: admin]

route: /obter_listas | method: GET | params: n/a | [DEVE ESTAR AUTENTICADO] //retorna as listas

route: /peritos_acionados/{idOcorrencia} | method: GET | params: n/a | [DEVE ESTAR AUTENTICADO] | method: POST | params: {"peritoAcionado": Perito._id} | [DEVE ESTAR AUTENTICADO] | method: DELETE | params: {"peritoAcionado": Perito._id} | [DEVE ESTAR AUTENTICADO]

route: /vestigios/{idOcorrencia} | method: GET | params: n/a | [DEVE ESTAR AUTENTICADO] | method: DELETE | params: {"vestigio": Vestigio._id} | [DEVE ESTAR AUTENTICADO] | method: POST | params: { tipo: tipo_vestigio._id coletado: boolean, etiqueta: String, informacoesAdicionais: String } | [DEVE ESTAR AUTENTICADO]