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 Tarifa Social(Municipal) ======

<columns> O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via Query Parameter. Precisa autenticar passando uma key via header. Presente apenas na versão municipal. </columns>

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

|**Parâmetro** |**Valor** |**Tipo** |
|matricula|Matrícula do Imóvel|String|

<columns> É esperado o seguinte Header:

|**Header** |**Valor** |**Tipo** |
|key|Chave de autenticação|String|

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

https://<URL_GSAN>:<porta>/gsan/chatbot/verificarMatriculaTarifaSocial?matricula=9999999

</code>

== Retornos ==

<columns> Com sucesso:

Caso imóvel exista e esteja na tarifa social.
<code javascript>
{"body": true}
</code>

Caso imóvel não esteja na tarifa social ou não exista.
<code javascript>
{"body": false}
</code>

Com erro:

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

</code>

Com erro de autenticação:

<code javascript>
{"error":{"detailMessage":"Chave não autorizada"}}

</code>

</columns>

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

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