Todos os dados retornados pela API estão no formato JSON e descrito de acordo com sua documentação
Informações sobre CEP, bairro e logradouros do município.
Método | URL | Descrição |
---|---|---|
GET |
/api/endereco/ceps?numero{numero}
|
Retorna os CEPs do município filtrando pelo número (visualizar). |
GET |
/api/endereco/ceps/{id}
|
Retorna os dados do CEP informado (visualizar). |
GET | /api/endereco/bairros | Retorna todos os bairros do município (visualizar). |
GET |
/api/endereco/bairros?descricao={descricao}
|
Retorna os bairros do município filtrando pela descrição (visualizar). |
GET |
/api/endereco/bairros/{id}
|
Retorna os dados do bairro informado (visualizar). |
GET |
/api/endereco/bairros/{bairroId} /logradouros
|
Retorna todos os logradouros relacionados ao bairro informado (visualizar). |
GET |
/api/endereco/bairros/{bairroId} /logradouros?descricao={descricao}
|
Retorna todos os logradouros relacionados ao bairro informado filtrando pela descrição do logradouro (visualizar). |
GET |
/api/endereco/logradouros?descricao={descricao}
|
Retorna os logradouros do município filtrando pela descrição (visualizar). |
GET |
/api/endereco/logradouros/{id}
|
Retorna os dados do logradouro informado (visualizar). |
GET |
/api/endereco/logradouros/{logradouroId} /bairros
|
Retorna todos os bairros relacionados ao logradouro informado (visualizar). |
A API de dados geográficos utiliza a o formato JSON do ArcGIS.
Método | URL | Descrição |
---|---|---|
GET | /api/geo | Retorna todas as camadas disponíveis para consulta (visualizar). |
GET | /api/geo/onibus | Retorna os dados geográficos referentes aos pontos de ônibus. (visualizar) |
GET | /api/geo/taxi | Retorna os dados geográficos referentes aos pontos de táxi. (visualizar) |
GET | /api/geo/bairros | Retorna os dados geográficos referentes aos bairros. (visualizar) |
GET | /api/geo/logradouros | Retorna os dados geográficos referentes aos logradouros. (visualizar) |
GET | /api/geo/locais | Retorna os dados geográficos referentes aos locais públicos (Equipamento Urbano > Locais). (visualizar) |
GET | /api/geo/pracas | Retorna os dados geográficos referentes às praça públicas. (visualizar) |
GET | /api/geo/ciclovias | Retorna os dados geográficos referentes às ciclovias. (visualizar) |
GET | /api/geo/balneabilidade | Retorna os dados geográficos referentes às situação de balneabilidade. (visualizar) |
GET | /api/geo/feiras | Retorna os dados geográficos referentes às feiras-livres do município. (visualizar) |
GET | /api/geo/restaurantes | Retorna os dados geográficos referentes a bares e restaurantes. (visualizar) |
GET |
/api/geo/{layerSlug} ?where={condition}
|
Filtra os dados da layer através da condição especificada. (visualizar) |
GET |
/api/geo/{layerSlug} ?geometryType=esriGeometryEnvelope&geometry={"xmin": {xmin} ,"ymin":{ymin} ,"xmax":{xmax} ,"ymax":{ymax} }
|
Filtra os dados da layer através da área especificada (xmin-xmax, ymin-ymax). (visualizar) |
GET |
/api/geo/geometry/{geometryType} /{service} /{layerId} /{codGeo}
|
Extrai e retorna a geometria de uma feature. Aonde:
|
A API de transporte público.
Método | URL | Descrição |
---|---|---|
GET | /api/transporte/onibus/linhas | Retorna a lista de linhas de ônibus (visualizar). |
GET |
/api/transporte/onibus/linhas/{id}
|
Retorna todas as informações da linha de ônibus incluindo itinerário e horários (visualizar). |
GET |
/api/transporte/onibus/linhas?descricao={descricao}
|
Retorna a lista de linhas de ônibus filtrando pela descrição (visualizar). |
GET | /api/transporte/onibus/vias | Retorna a lista das vias por onde os ônibus passam (visualizar). |
GET |
/api/transporte/onibus/vias/{id}
|
Retorna todas as informações da via (visualizar). |
GET |
/api/transporte/onibus/vias?descricao={descricao}
|
Retorna a lista das vias por onde os ônibus passam filtrando pela descrição (visualizar). |
A API dos serviços prestados pela prefeitura.
Método | URL | Descrição |
---|---|---|
GET | /api/guia/servicos | Retorna a lista de serviços disponíveis (visualizar). |
GET |
/api/guia/servicos?descricao={descricao}
|
Retorna a lista de serviços disponíveis filtrando pela descrição ou resumo (visualizar). |
A API dos equipamentos urbanos (locais) da prefeitura.
Método | URL | Descrição |
---|---|---|
GET | /api/equipamento/locais | Retorna a lista de locais (visualizar). |
GET |
/api/equipamento/locais?descricao={descricao}
|
Retorna a lista de locais filtrando pelo nome ou observacao (visualizar). |
GET | /api/equipamento/tipos | Retorna a lista de tipos de equipamentos urbanos (visualizar). |
A API de atendimento ao público.
Método | URL | Descrição |
---|---|---|
GET | /api/atendimento/servicos | Lista os serviços disponíveis para o agendamento |
GET |
/api/atendimento/unidade/{servico}
|
Lista as unidades de atendimento do serviço |
GET |
/api/atendimento/agendamentos/search?cpf={cpf}
|
Busca os agendamentos por CPF |
DELETE |
/api/atendimento/agendamentos/{id}
|
Cancela um agendamento |
POST |
/api/atendimento/agendamentos/{servico} /{unidade} /check
|
Retorna o próximo horário disponível. Enviar o mesmo JSON de agendar um novo atendimento. Essa chamada serve para possibilitar uma confirmação ao usuário. |
POST |
/api/atendimento/agendamentos/{servico} /{unidade}
|
Agenda novo atendimento. |
A API de cadastro de pessoas da prefeitura
Método | URL | Descrição |
---|---|---|
GET |
/api/pessoa/pessoas?nome={nome}
|
Retorna a lista de pessoas filtrando Nome (mínimo de 4 caracteres). (visualizar). |
GET |
/api/pessoa/pessoas?cpf={cpf}
|
Retorna a lista de pessoas filtrando por CPF. (visualizar). |
GET |
/api/pessoa/pessoas/{id}
|
Retorna os dados completo da Pessoa escolhida. (visualizar). |
Integração com os chamados do Sistema de Informações ao Cidadão
Método | URL | Descrição |
---|---|---|
GET | /api/sic/servicos | Retorna todos os serviços disponíveis para o usuário poder escolher no chamado (visualizar). |
GET |
/api/sic/servicos/{id}
|
Retorna os dados completo do serviço informado pelo id, incluindo as perguntas que precisam ser respondida (visualizar). |
GET | /api/sic/chamados | Retorna todos os chamados de um único solicitante. É necessário informar o e-mail do solicitante (parâmetro email, via querystring): Exemplo: Chamados do solicitante meuemail@email.com |
GET |
/api/sic/chamados/{id}
|
Retorna os dados completo do chamado informado pelo id, incluindo respostas e histórico. Também é necessário informar o e-mail do solicitante (visualizar). |
POST | /api/sic/chamados |
Adiciona um novo chamado.
{
"descricao": ,
"complemento": ,
"pontoReferencia": ,
"numeroResidencia": ,
"servico": ,
"solicitante": | { "email": string, "nome": string, "cpf": string, "telefone": string, "celular": string },
"bairro": ,
"logradouro": ,
"respostas": [
{
"opcao": ,
"descricao":
}
],
"arquivos": [
{
"type":
"data":
}
]
}
|