O detalhe de um imóvel pelo seu propertyId, com exatamente a mesma forma que GET /api/action/express-v1/properties/{propertyHash}.
Existe por um motivo concreto: properties/sitemap retorna o propertyId e não o hash, portanto este é o serviço que permite abrir o anúncio de um imóvel que um visitante encontrou pelo sitemap.
| Informações do recurso | |
|---|---|
| Autenticação | Obrigatória (Token de API, Bearer) |
| Scope | express-base |
| HTTP Method | GET |
| Response | JSON |
| Version | 1 |
URL do recurso
https://mapaprop.app/api/action/express-v1/properties/id/{propertyId}
Parâmetros
| Key | Type | Required | Descrição |
|---|---|---|---|
| propertyId | integer | yes | O id do imóvel, na URL. Precisa ser um inteiro maior que 0 |
Código de exemplo
GET /api/action/express-v1/properties/id/257007 HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}
Resposta
A mesma da leitura por hash: o objeto do imóvel, com os seus attributes filtrados, os seus vídeos, a sua filial e o tipo e a operação com a sua descrição. Como essa leitura, registra uma visita ao imóvel.
| Caso | Resposta |
|---|---|
| O imóvel existe e é da sua conta | 200 com o objeto do imóvel |
| Não existe, ou não é da sua conta | 404 com {"success": false, "message": "Property not found"} |
| O id não é um inteiro maior que 0 | 400 com INVALID_INPUT ou INVALID_NUMBER |
Exemplo de resposta de erro
{
"success": false,
"message": "Property not found"
}
Os imóveis não publicados não são retornados, igual que em todos os outros serviços de leitura.