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 Validar Obter Débito Imóvel Parcelamento ======

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

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

|**Parâmetro** | **Valor** | **Tipo** |
|matricula| Id do imóvel|String|obrigatório|
|resolucaoDiretoria| Id da resolução de diretoria|String|opcional|
|hash| hash utilizado para identificar o parcelamento|String|obrigatório|
|parcela| Quantidade de parcelas|String|opcional|
|cpfCnpj| Cpf ou cnpj do cliente|String|opcional|
  
</columns>

O cpf/cnpj é opcional. Quando informado, retorna os debitos do imóvel XXX associado ao cpf/cnpj informado.

== Exemplo de Requisição ==
<code>
https://<URL_GSAN>:<porta>/gsan/validarObterDebitoImovelParcelamento?matricula=878510&hash=0195f2e1-22b9-1826-841d-6cc2823505c286c5&resolucaoDiretoria=138
</code>

OU 

<code>
https://<URL_GSAN>:<porta>/gsan/validarObterDebitoImovelParcelamento?matricula=878510&hash=0195f2e1-22b9-1826&resolucaoDiretoria=138&cpfCnpj=29204631015
</code>

== Retornos ==
<columns>
 Com sucesso:
<code javascript>
{
    "body": {
        "valorContas": 581.85,
        "valorGuias": 0,
        "valorAcrescimos": 44.01,
        "valorDebitos": 0,
        "valorParcelamento": 143.96,
        "valorCredito": 0,
        "valorTotal": 769.82,
        "valorMinimoEntrada": 0,
        "valorAVista": 725.81
    }
}
</code>

Com erro:

<code javascript>
{
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "O responsável para o parcelamento tem que ser pessoa física."
    }
}
</code>
</columns>

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

| **Código** | **Mensagem**
|200 | "OK"|
|500 | "Internal Server Error"|