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-verificar-matricula-cpf-cnpj

Web Service Encerrar Registro Atendimento

O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter. A funcionalidade irá verificar Registro de Atendimento informado se é existente, caso positivo, ele irá encerra-lo com motivo: 2 - CONCLUSÃO DO SERVIÇO.

São esperados os seguintes parâmetros:

Parâmetro Valor Tipo
Numero do Registro de AtendimentoMatrícula do ImóvelString
cpfCnpjCpf ou CNPJ do clienteString
atualIndicador se vinculo atual. 1(Sim) ou 2 (Não)Integer
Exemplo de Requisição
https://<URL_GSAN>:<porta>/gsan/verificarMatriculaCpfCnpj?matricula=999999&cpfCnpj=99999999999&atual=1
Retornos

Com sucesso:

Caso imóvel exista e esteja na tarifa social.

{
    "body": {
        "cpfCnpjValido": true,
        "matriculaValida": true,
        "matriculaExistente": true,
        "cpfCnpjVinculados": false
    }
}

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”
422“Unprocessable Entity”
integracoes/web-services-verificar-matricula-cpf-cnpj.txt · Última modificação: 16/10/2025 13:00 por tiago.moreno