Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.

{{ajuda:logo-gsan3.png?90|}}


====== WebService Status Autoleitura ======

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

Ele possui os seguintes Headers:

|Key|Value|
|client_id|testeAutoLeitura|
|client_secret|admin|

</columns>

<columns>
Ele espera o seguinte Parâmetro:

  - matricula, //Int// contendo o id do imóvel.

</columns>

===== Exemplo de requisição para o sistema =====

Com a seguinte informação:

|matricula |2041367|


===== Exemplo de requisição Seria =====

http://192.168.60.105:8080/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 **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.