Essa é uma revisão anterior do documento!

Web Service Verificar Matrícula Tarifa Social(Municipal)

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.

São esperados os seguintes parâmetros:

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

É esperado o seguinte Header:

Header	Valor	Tipo
key	Chave de autenticação	String

Exemplo de Requisição

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

Retornos

Com sucesso:

{"body": true}

{"body": false}

Com erro:

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

Com erro de autenticação:

{"error":{"detailMessage":"Chave não autorizada"}}

Possíveis Códigos de Retorno

Código
200	“OK”
401	“Unauthorized”
500	“Internal Server Error”