Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-pesquisar-imoveis

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

integracoes:web-services-pesquisar-imoveis [12/12/2019 19:18] (atual)
tadeu.sarmento criada
Linha 1: Linha 1:
 +{{ajuda:​logo-gsan3.png?​90|}}
  
 +
 +====== WebService Pesquisar Imóveis ======
 +
 +<​columns>​
 +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:​
 +  - key, //String// contendo a chave de autenticação da empresa.
 +  - value, //String// contendo o CPF/CNPJ do cliente que se pretende pesquisar.
 +</​columns>​
 +\\
 +
 +===== Exemplo de requisição para o sistema =====
 +
 +Com as seguintes informações:​
 +|IP|192.168.64.111|
 +|Chave de autenticação|aBC123DEF|
 +|CPF|733.328.638-11|
 +
 +
 +\\
 +
 +===== A Requisição Seria =====
 +
 +http://​192.168.64.111:​8080/​gsan/​pesquisarImoveis?​key=aBC123DEF&​value=73332863811
 +
 +\\
 +
 +===== Retorno em Caso de Sucesso =====
 +<code javascript>​
 +{
 + "​key":​ (String) chave de autenticação recebida pelo Webservice,
 + "​qtd":​ (Integer) número de dados retornados pelo Webservice,
 + "​resultado":​ Lista de Objetos contendo as matrículas (Inteiro).
 + [
 + "​matricula"​ : (Inteiro) matrícula de um imóvel.
 + ]
 +}
 +
 +</​code>​
 +\\
 +
 +**Exemplo**:​
 +
 +<WRAP center round box 100%>
 +{{  :​integracoes:​pesquisar_imovel_json_1.jpg?​nolink ​ |}}
 +</​WRAP>​
 +
 +\\
 +
 +===== Retorno em Caso de erro =====
 +<code javascript>​
 +{
 + "​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
 +}
 +
 +
 +</​code>​
 +
 +**Exemplo**:​
 +
 +\\
 +<WRAP center round box 100%>
 +{{  :​integracoes:​pesquisar_imovel_json_2.jpg?​nolink ​ |}}
 +</​WRAP>​
 +
 +\\
 +
 +===== Possíveis Códigos de Retorno =====
 +|Código|Mensagem|
 +|400|"​parâmetros inválidos"​|
 +|401|"​chave inválida"​|
 +|404|"​A consulta não trouxe resultados"​|
 +|500|“”|
 +\\
 +
 +Clique **[[=treinamentos:​integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.
integracoes/web-services-pesquisar-imoveis.txt · Última modificação: 12/12/2019 19:18 por tadeu.sarmento