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 | 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” ] |
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.