Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-status-autoleitura

Essa é uma revisão anterior do documento!


WebService Status Autoleitura

O WebService recebe apenas requisições do tipo POST, e os parâmetros são passados via Query Parameter.

Ele possui os seguintes Headers:

KeyValue
client_idtesteAutoLeitura
client_secretadmin

Ele espera o seguinte Parâmetro:

  1. matricula, Int contendo o id do imóvel.

Exemplo de requisição para o sistema

Com a seguinte informação:

matricula 2041367

A Requisição Seria

http:<IP_APLICAÇÃO_GSAN>/gsan/api/statusAutoleitura ===== RAW ===== <code javascript> { “matricula” : 2041567 } </code> ===== Retorno com Sucesso ===== <code javascript> { “body”: { “imovelEncontrado”: true, “endereco”: “RUA JOS, 3”, “cadastradoAutoleitura”: false, “permitidoCadastrar”: true, “autoLeituraFeitaReferenciaAtual”: false, “autoLeituraInicio”: “2024-11-12T00:00:00-0300”, “autoLeituraFim”: “2024-11-27T00:00:00-0300”, “proximaAutoLeituraInicio”: “2024-12-12T00:00:00-0300”, “proximaAutoLeituraFim”: “2024-12-27T00:00:00-0300”, “referencia”: “10/2024” } } </code> ===== Retorno em caso de Erro ===== <code javascript> { “error”: { “erroInformado”: “INPUT_ERRADO”, “detailMessage”: “matricula Inválido”, “stackTrace”: [], “suppressedExceptions”: [] }, “message”: “matricula Inválido” } </code> ===== Possíveis Códigos de Retorno ===== |Código|Mensagem|Body |200|“OK”| |500|“Internal Server Error”| |404|“Page not found”| |422|“Não foi possivel encontrar o período”|
Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-status-autoleitura.1732762639.txt.gz · Última modificação: 28/11/2024 02:57 por jefferson.barbosa