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-dia-atual-vencimento

Web Service Dia Atual de Vencimento

O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter. A funcionalidade irá buscar o dia de vencimento do imóvel informado.

São esperados os seguintes parâmetros:

Parâmetro Valor Tipo
matriculaMatrícula do ImóvelString
Exemplo de Requisição
https://<URL_GSAN>:<porta>/gsan/chatbot/diaAtualVencimento?matricula=9999999
Retornos

Com sucesso:

Caso imóvel exista e tenha um dia informado.

{
    "body": {
        "dia": 2
    }
}

Caso imóvel exista e NÃO tenha um dia informado.

{
    "body": {}
}

Caso NÃO exista imóvel.

{}

Com erro:

{
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "Erro de acesso ao banco de dados, favor contactar administrador do sistema.",
        "stackTrace": [],
        "suppressedExceptions": []
    }
}
Possíveis Códigos de Retorno
Código
200“OK”
500“Internal Server Error”
integracoes/web-services-dia-atual-vencimento.txt · Última modificação: 25/10/2025 23:40 por jefferson.araujo