Este artigo descreve o serviço da API responsável pela pesquisa de imóveis. Este serviço geralmente é consumido pelo site do cliente.
Segurança
Para acessar o serviço de pesquisa, a aplicação deve enviar um token de acesso fornecido pelo administradora da organização.
Endpoint
Para acessar o serviço de pesquisa o sistema deve fazer uma requisição do tipo "POST” no “EndPoint” definido pela “URL Org” da organização
Verbo | POST |
---|---|
Url org | Endereço fornecido pelo administrador. Exemplo: https://snapproperty-developer-edition.na132.force.com |
Serviço | /services/apexrest/snap_brok/imovel/pesquisar |
Endpoint | https://snapproperty-developer-edition.na132.force.com/services/apexrest/snap_brok/imovel/pesquisar |
Parâmetros para pesquisa
Os parâmetros utilizados para pesquisa estão descritos na tabela abaixo.
Parâmetro | Tipo | Descrição | Exemplo |
---|---|---|---|
Offset | Número | Utilizado na paginação de registros para definir a posição inicial do primeiro imóvel a ser retornado. | 0 |
RegistrosPagina | Número | Utilizado na paginação de registros para definir a quantidade de imóveis que devem ser retornados. | 25 |
Filtros | Array[String] | Lista de filtros que devem ser considerados na pesquisa de imóveis. Cada filtro deve ser composto por:
| [ “AND snap_brok__Disponivel_locacao__c = TRUE”, “AND snap_brok__area_privativa__c >= 100” ] |
Ordenacao | String | Define a regra para ordenação dos imóveis encontrados. | snap_brok__Valor_locacao_total__c DESC |
Retorno da pesquisa
Retorno com sucesso
Na tabela abaixo estão descritos os campos retornados pelo serviço quando a pesquisa é realizada com sucesso.
Campo | Tipo | Descrição | Exemplo |
---|---|---|---|
Total | Número | Indica a quantidade total de imóveis encontrados com os filtros aplicados. | 90 |
Mensagem | String | Mensagem do sistema | "Pesquisa realizada com sucesso" |
Imoveis | Array[Imovel] | Array com os registros dos imóveis retornados pela pesquisa. | [ { "attributes": { } |
Erro | Boolean | FALSE |
Exemplo:
{ "Total": 90, "Mensagem": "Pesquisa realizada com sucesso", "Imoveis": [ { "attributes": { "type": "snap_brok__Imovel__c", "url": "/services/data/v51.0/sobjects/snap_brok__Imovel__c/a050B00000fnHxDQAU" }, "Id": "a050B00000fnHxDQAU", "Name": "Rua T-38 0 Apto 2001", "snap_brok__area_privativa__c": 158.51, "snap_brok__Banheiros__c": 2, "snap_brok__Complemento__c": "Apto 2001", "snap_brok__codigo__c": "I-001299", "snap_brok__Disponivel_venda__c": false, "snap_brok__Dormitorios__c": 2, "snap_brok__Localizacao__c": null, "snap_brok__Logradouro__c": "Rua T-38", "snap_brok__Numero__c": "0", "snap_brok__Situacao__c": "Disponível", "snap_brok__Suites__c": 2, "snap_brok__Tipo_uso_3__c": "a4I0B000000RI6uUAG", "snap_brok__Tipo_imovel_2__c": "a4H0B000000QdY5UAK", "snap_brok__Vagas__c": 2, "snap_brok__Valor_Condominio__c": 77000.00, "snap_brok__Valor_locacao_total__c": 77000.00, "snap_brok__Valor_locacao_por_m2__c": 485.77, "snap_brok__Valor_IPTU__c": 9660.00, "snap_brok__Fotos_de_im_vel__r": { "totalSize": 2, "done": true, "records": [ { "attributes": { "type": "snap_brok__Foto_Imovel__c", "url": "/services/data/v51.0/sobjects/snap_brok__Foto_Imovel__c/a060B00000jrTyeQAE" }, "snap_brok__Imovel__c": "a050B00000fnHxDQAU", "Id": "a060B00000jrTyeQAE", "snap_brok__Url_imagem__c": "http://www.essenciamoveis.com.br/blog/wp-content/uploads/2017/01/cozinha-conjugada-com-sala-de-jantar.jpg", "snap_brok__Ordem__c": 1 }, { "attributes": { "type": "snap_brok__Foto_Imovel__c", "url": "/services/data/v51.0/sobjects/snap_brok__Foto_Imovel__c/a060B00000jrTyfQAE" }, "snap_brok__Imovel__c": "a050B00000fnHxDQAU", "Id": "a060B00000jrTyfQAE", "snap_brok__Url_imagem__c": "https://www.adorodecorar.com.br/wp-content/uploads/2015/07/2364-apartamentos-decorados-dicas.jpg", "snap_brok__Ordem__c": 2 } ] }, "snap_brok__Tipo_uso_3__r": { "attributes": { "type": "snap_brok__Tipo_uso__c", "url": "/services/data/v51.0/sobjects/snap_brok__Tipo_uso__c/a4I0B000000RI6uUAG" }, "Id": "a4I0B000000RI6uUAG", "Name": "Residencial" }, "snap_brok__Tipo_imovel_2__r": { "attributes": { "type": "snap_brok__Tipo_imovel__c", "url": "/services/data/v51.0/sobjects/snap_brok__Tipo_imovel__c/a4H0B000000QdY5UAK" }, "Id": "a4H0B000000QdY5UAK", "Name": "Apartamento" } } ], "Erro": false }
Retorno com erro
Campo | Tipo | Descrição | Exemplo |
---|---|---|---|
Total | Número | null | |
Mensagem | String | Mensagem de erro gerada pelo serviço | "Erro na pesquisa de imóveis: Erro na pesquisa de imóveis: unexpected token: '100' - linha: 493 na linha 502" |
Imoveis | Array[Imovel] | null | |
Erro | Boolean | TRUE |
Exemplo:
{ "Total": null, "Mensagem": "Erro na pesquisa de imóveis: Erro na pesquisa de imóveis: unexpected token: '100' - linha: 493 na linha 502", "Imoveis": null, "Erro": true }
Filtros
Na tabela abaixo estão relacionados os campos que são retornado pelo serviço e que também podem ser utilizados como opções de filtro.
Campo | Descrição | Exemplo |
---|---|---|
| Nome do imóvel. | |
ID | ID interno do imóvel no SnapProperty (não é o código do imóvel). | |
| Código gerado pelo sistema para identificar o imóvel. |
|
| Área privativa do imóvel. |
|
| Quantidade de banheiros do imóvel. |
|
| Indica se o imóvel está disponível para venda.
|
|
| Quantidade de dormitórios do imóvel. |
|
| Identifica as coordenadas (latitude) do endereço do imóvel. |
|
| Identifica as coordenadas (longitude) do endereço do imóvel. |
|
| Nome da rua onde o imóvel está localizado. | |
| Número do endereço do imóvel. | |
| Complemento do endereço do imóvel. | |
| Identifica o bairro onde o imóvel está localizado. |
|
| Identifica a cidade onde o imóvel está localizado. |
|
| Indica o CEP do endereço do imóvel. |
|
| Indica a situação do imóvel em relação à sua disponibilidade para comercialização. |
|
| Número de suítes do imóvel. |
|
| Indica o tipo de uso do imóvel. |
|
| Indica o tipo do imóvel. |
|
| Indica o total de vagas (cobertas e descobertas) do imóvel. |
|
| Valor mensal do condomínio. |
|
| Valor total da locação (Aluguel + IPTU + Condomínio). |
|
|
| |
| Valor mensal do IPTU. |
|
| Descrição do imóvel. | |
| Altura do pé direiro (m²) do imóvel. | |
| Número do andar onde o imóvel está localizado. |
|
| Identifica o condomínio onde está localizado o imóvel. |
|
| Indica o valor desejado do aluguel. |
|
| Indica o valor mensal do IPTU rateado. |
|
| Valor sugerido pelo locador para venda do imóvel. |
|
| Retorna uma lista com as fotos do imóvel | |
| Retorna o código do imóvel vinculado a foto. | |
| Retorna link da foto. | |
| Retorna link da foto 200px. | |
| Retorna link da foto 400px. | |
| Retorna link da foto 800px. | |
| Ordem de exibição da foto. |