Essa é uma revisão anterior do documento!

Web Service Emitir Extrado de Parcelamento à vista Código de Barras(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
resolucaoDiretoria	Resolução de diretoria. Opcional, se não informado usará um default.	String

É esperado o seguinte Header:

Header	Valor	Tipo
key	Chave de autenticação	String

Exemplo de Requisição

https://<URL_GSAN>:<porta>/gsan/chatbot/emitirExtratoParcelamentoAVistaCodigoBarras?matricula=99999&resolucaoDiretoria=99

Retornos

Com sucesso:

{
    "body": {
        "codigoBarras": "826400000012122600431052000001643006140523814154",
        "codigoBarrasFormatado": "82640000001-2 12260043105-2 00000164300-6 14052381415-4",
        "valorDocumento": 112.26
    }
}

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”