Pesquisa Vazamentos - API

Consultas

Pesquisas

Para consulta das pesquisas realizadas utilize a rota /pesquisa_vazamento

A consulta podem conter filtros nos parâmetros como município, período, setor, etc, caso não seja informado nenhum parâmentro, irá retornar todos os registros

Requisição:

Método: GET
Endereço: https://apipesquisavazamento.localsig.com/pesquisa_vazamento
Descrição Irá retornar todas tarefas realizadas
Parâmetros id, dataIni, dataFim, cidade, setor, resp

Parâmetros: (query)

Parâmetro tipo Descrição Exemplo
id number ID do registro 756
dataIni string Data Inicial (período) 2022-09-15
dataFim string Data Final (período) 2022-10-20
cidade string cidade em que foi feita a pesquisa SÃO JOSÉ DOS CAMPOS
setor string setor de abastecimento do registro VILA TATETUBA
resp string responsável pela pesquisa Lucas Danilo

Exemplos:
/ pesquisa_vazamento

Como não foi passado nenhum parâmetro, será retornado todas as pesquisas realizadas


/ pesquisa_vazamento?dataIni=2022-08-20&dataFim=2022-09-20

Irá trazer todos os registros dentro do período informado


/ pesquisa_vazamento?dataIni=2022-08-20&dataFim=2022-09-20&cidade=SÃO JOSÉ DOS CAMPOS

Irá trazer todos os registros dentro do período informado e no município de São José dos Campos





Municípios

Todos os municípios

Para consultar todos os municípios utilize a rota /cities

Requisição:

Método: GET
Endereço: https://apipesquisavazamento.localsig.com/cities
Descrição Irá retornar todos os municípios cadastrados

Exemplo:
/ cities

Retorna todos os municípis cadastrados






Consulta por município

Para consulta da base de dados dos município utilize a rota /getCity/[nome do município]

Consulta informações sobre o município informado na rota

Requisição:

Método: GET
Endereço: https://apipesquisavazamento.localsig.com/getCity/:name
Descrição Irá retornar informações do município informado
Parâmetros (Obrigatório) [nome do município]

Parâmetros: (route)

Parâmetro tipo Descrição Exemplo
nome string Nome do município SÃO JOSÉ DOS CAMPOS

Exemplos:
/ getCity/CAMPOS DO JORDÃO

Irá retornar a base de dados se setor, bairros e ruas do município de Campos de Jordão


/ getCity/QUELUZ

Irá retornar a base de dados se setor, bairros e ruas do município de QUELUZ