O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter. Ele espera os seguintes Parâmetros:
|
Com as seguintes informações:
IP | 192.168.64.111 |
Chave de autenticação | aBC123DEF |
CPF | 733.328.638-11 |
{ "key": (String) chave de autenticação recebida pelo Webservice, "qtd": (Integer) número de dados retornados pelo Webservice, "resultado": Lista de Objetos contendo os campos abaixo: [ "matricula" : (Inteiro) matrícula de um imóvel. "endereco" : (String) endereço do imóvel. "diaVencimento" : (Inteiro) dia do vencimento da conta. ] }
Exemplo:
{ "key": "AB87FS9DF8D", "qtd": 2, "resultado": [ { "matricula": "123456", "endereco": "RUA SONIA ALVES LOPES, 2000 - COROA DO MEIO ARACAJU SE 10020-740", "diaVencimento": "2" }, { "matricula": "789987", "endereco": "RUA ABC, 1500 - COROA DO MEIO ARACAJU SE 54020-000", "diaVencimento": "24" } ], }
{ "error": (Integer) Código de erro da requisição, "msg": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500, "qtd": (Integer) sempre valor 0 }
Exemplo:
Código | Mensagem |
400 | “parâmetros inválidos” |
401 | “chave inválida” |
404 | “A consulta não trouxe resultados” |
500 | “” |
Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.