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

====== WebService Verificar Bloqueio Protesto Cartório Matricula ======

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

<columns>
Ele espera os seguintes Parâmetros:

|**Parâmetro** | **Valor** | **Tipo** |
|matricula|  Identificador do Imóvel a ser verificado| String|
|key| Chave de API do Bot| String| 
  
</columns>

== Exemplo de Requisição ==
<code>
https://<URL_GSAN>:8080/gsan/verificarBloqueioProtestoCartorioMatricula?matricula=123456&key=abc54321
</code>

== Retornos ==
<columns>
 Sem protesto ativo
<code javascript>
{
  "key": "abc54321",
  "body": {
    "possuiBloqueioProtestoCartorio": false,
    "matriculaImovel": 123456
  }
}
</code>

Com protesto Ativo

<code javascript>
{
  "key": "abc54321",
  "body": {
    "possuiBloqueioProtestoCartorio": true,
    "matriculaImovel": 178778
  }
}
</code>
</columns>

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

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