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

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

Exemplo de requisição Seria

RAW

{
  "matricula" : 2041567
}

Retorno com Sucesso

{
    "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"
    }
}

Retorno em caso de Erro

{
    "error": {
        "erroInformado": "INPUT_ERRADO",
        "detailMessage": "matricula Inválido",
        "stackTrace": [],
        "suppressedExceptions": []
    },
    "message": "matricula Inválido"
}

Possíveis Códigos de Retorno

CódigoMensagem
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.txt · Última modificação: 28/11/2024 02:58 por jefferson.barbosa