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-efetuar-autoleitura

WebService Efetuar 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.
  2. leitura, Int contendo a leitura do medidor/Hidrômetro do imovel.
  3. foto, String contendo um arquivo Base64, com a imagem da leitura

Exemplo de requisição para o sistema

Exemplo de requisição Seria

RAW

      {
        "matricula":"2317591",
        "leitura":"45678",
        "foto":"https://message-file.tatodesk.net/public/file?	     token=VTJGc2RHVmtYMTg3SGZpWFhYdy96RnFPeGk2SjBDcGVwZ3J5Q3V2UjNIeTFRd3p6UDdtVGUyVjRydkxXLzNaMU0wWnRpeXpUb01TY3BmTnIrMkdOVHZ6Vk1QbWQvT0c4RmlySEVQOVJBWDhnTlR4NXY3dm5WQXhiSkE5MzcwZmRHWkRmYmtXWUlUek5ZMmpjM2lJVjVoNnpMUWd2S3F5VzhMSVBlajFkNFljPQ=="
      }

Para a realização dos testes, foi utilizada uma imagem em formato Base64, extraída de uma URL pública.

Retorno com Sucesso

- Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver desabilitado:

{
    "body":{
    	"processado" : true,
        "visitaLeiturista" : false 
    }
}

- Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver habilitado:

{
    "body":{
    	"processado" : true,
        "visitaLeiturista" : true 
    }
}

Retorno em caso de Erro

- Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver desabilitado:

{
    "body":{
    	"processado" : false,
        "visitaLeiturista" : false 
    }
}

- Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver habilitado:

{
    "body":{
    	"processado" : false,
        "visitaLeiturista" : true 
    }
}

Possíveis Códigos de Retorno

CódigoMensagem
200“OK”
500“Internal Server Error”
404“Page not found”
422“Não foi possível encontrar o período”


Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-efetuar-autoleitura.txt · Última modificação: 28/11/2024 05:33 por jefferson.barbosa