Criar Imóvel

Nessa rota você pode criar um novo imóvel.

POST https://api.imobiliary.com/properties

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 fornecer o corpo da requisição no seguinte formato.

{
  "status": "Disponível",
  "water_id": "1234567@6",
  "energy_id": "123456778",
  "kind": "Residencial",
  "address": {
    "street": "Rua da Saudade",
    "number": "099",
    "neighborhood": "Vl. Nobre",
    "complement": "",
    "city": "São Paulo",
    "state": "SP",
    "zip_code": "15550000"
  }
}

Respostas

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

201

Receberá essa resposta caso forneça um corpo da requisição válido.

HTTP/1.1 201 Created
Location: /properties/22be508a-8505-4dbb-8b36-bfe1c4adb008

400

Receberá essa resposta caso não forneça o corpo da requisição ou informe algum dos campos de forma incorreta. Exemplo:

{
  "status": "Disponível",
  // sem o campo water_id
  "energy_id": "123456778",
  "kind": "Residencial",
  "address": {
    "street": "Rua da Saudade",
    "number": "099",
    "neighborhood": "Vl. Nobre",
    "complement": "",
    "city": "São Paulo",
    "state": "SP",
    "zip_code": "15550000"
  }
}

Resposta:

{
  "status": "Bad Request",
  "code": 400,
  "result": {
    "code": 400,
    "message": "cód. água do imóvel não pode ser vazio",
    "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"
  }
}

409

Receberá essa resposta caso o corpo da requisição conflite com dados de water_id, energy_id ou address já existentes.

{
  "status": "Conflict",
  "code": 409,
  "result": {
    "code": 409,
    "message": "imóvel já existe",
    "error": "Conflict"
  }
}

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"
  }
}