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

====== Web Service Verificar Matrícula CPF/CNPJ ======

<columns> O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via Query Parameter. A funcionalidade irá verificar a relação do CPF/CNPJ informado com o imóvel no tipo de relação sendo relação de **USUARIO**, se existir irá retornar um booleano positivo se o vinculo existir. É possível também verificar se o vinculo já existiu em algum momento apenas passando o indicador **atual** como falso na requisição.</columns>

<columns> São esperados os seguintes parâmetros:

|**Parâmetro** |**Valor** |**Tipo** |
|matricula|Matrícula do Imóvel|String|
|cpfCnpj|Cpf ou CNPJ do cliente|String|
|atual|Indicador se vinculo atual. 1(Sim) ou 2 (Não)|Integer|

== Exemplo de Requisição ==
<code>

https://<URL_GSAN>:<porta>/gsan/verificarMatriculaCpfCnpj?matricula=999999&cpfCnpj=99999999999&atual=1

</code>

== Retornos ==

<columns> Com sucesso:

Caso imóvel exista e esteja na tarifa social.

<code javascript>
{
    "body": {
        "cpfCnpjValido": true,
        "matriculaValida": true,
        "matriculaExistente": true,
        "cpfCnpjVinculados": false
    }
}

</code>

Com erro:

<code javascript>
{
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "Erro de acesso ao banco de dados, favor contactar administrador do sistema.",
        "stackTrace": [],
        "suppressedExceptions": []
    }
}


</code>

</columns>

== Possíveis Códigos de Retorno ==

|**Código** | |
|200|"OK"|
|422|"Unprocessable Entity"|