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 Concluir 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|
|hash| hash utilizado para identificar o parcelamento|String|obrigatório|
|email| Email para onde será enviado a conclusão do parcelamento|String|opcional|
|parcelas| Quantidade de parcelas|String|obrigatório|
  
 
</columns>

Observação: Se o email for informado, o cliente recebe a guia de entrada e o termo de parcelamento por email. 

== Exemplo de Requisição ==
<code>
https://<URL_GSAN>:<porta>/gsan/concluirParcelamentoChatBot?matricula=70380627&hash=0195f2e1-22b9-1826-841d-6cc2823505c286cc&parcelas=1&email=teste@email.com
</code>

== Retornos ==
<columns>
 Com sucesso: (retorna o ID do parcelamento)
<code javascript>
{
    "body": 630042
}
</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** | **Mensagem**
|200 | "OK"|
|500 | "Internal Server Error"|