Buscar Imóvel

Nessa rota você pode buscar um imóvel cadastrado pelo imóvel autenticado, através do id.

GET https://api.imobiliary.com/properties/:property_id

Nota:

Esta rota requer autenticação. Você deve fornecer o cabeçalho Authorization com um token de autenticação válido. O token deve ser obtido através da rota de autenticação.

Requisição

Para realizar essa requisição, deve-se informar um id de imóvel válido e que tenha sido cadastrado por você, para assim trazer seus dados. Exemplo:

GET https://api.imobiliary.com/properties/22be508a-8505-4dbb-8b36-bfe1c4adb008

Respostas

Esses são as possíveis respostas desta requisição.

200

Receberá essa resposta caso informe um id de imóvel existente e que tenha sido cadastrado por você.

{
  "status": "OK",
  "code": 200,
  "result": {
    "id": "22be508a-8505-4dbb-8b36-bfe1c4adb008",
    "status": "Disponível",
    "kind": "Residencial",
    "water_id": "1234567@6",
    "energy_id": "123456778",
    "owner_id": "",
    "address": {
      "mini_address": "Rua da Saudade, 099, Vl. Nobre, São Paulo/SP",
      "street": "Rua da Saudade",
      "number": "099",
      "neighborhood": "Vl. Nobre",
      "city": "São Paulo",
      "state": "SP",
      "zip_code": "15550000"
    },
  }
}

400

Receberá essa resposta caso informe um id de imóvel invalido.

{
  "status": "Bad Request",
  "code": 400,
  "result": {
    "code": 400,
    "message": "id do recurso inválido",
    "error": "Bad Request"
  }
}

401

Receberá essa resposta caso não envie o token de autenticação no cabecalho Authorization, caso o token enviado não seja válido ou tenha expirado.

{
  "status": "Unauthorized",
  "code": 401,
  "result": {
    "code": 401,
    "message": "token inválido ou expirado",
    "error": "Unauthorized"
  }
}

403

Receberá essa resposta caso informe um id de imóvel que não foi cadastrado por você.

{
  "status": "Forbidden",
  "code": 403,
  "result": {
    "code": 403,
    "message": "acesso negado a este recurso",
    "error": "Forbidden"
  }
}

404

Receberá essa resposta caso informe um id de imóvel que não existe.

Nota:

Caso não informe o id de um imóvel, será devolvida uma resposta sem o formato padrão de erro.

{
  "status": "Not Found",
  "code": 404,
  "result": {
    "code": 404,
    "message": "imóvel não encontrado ou não existente",
    "error": "Not Found"
  }
}

500

Receberá essa resposta caso ocorra um erro interno no servidor. Isso pode acontecer por diversos motivos, como problemas de conexão com o servidor.

Caso o problema persista Entre em contato

{
  "status": "Internal Server Error",
  "code": 500,
  "result": {
    "code": 500,
    "message": "erro interno do servidor",
    "error": "Internal Server Error"
  }
}