Create an accommodation

POST /accommodation

Example about polymorphism in API. This endpoint 'POST /accommodation' can be used to create either apartment, either house.

Body object

type string Required Discriminator

This property is used to easily identify House VS Apartment

Value is house.
size integer Required

Area, in square meters (m²)
monthy_rent integer Required

Monthly rent, in dollars ($)
address string Required

Address for the accommodation
garden_size integer | null

Area, in square meters (m²).
roof_tiles_type string

Multiple types exist for roof tiles.

Values are Clay, Slate, Metal, Concrete, Solar, or Synthetic.
solar_panels_power integer | null

Installed photovoltaic power, in Watt (Wc). Yes, modern house should have solar panels
basement_size integer | null

Area, in square meters (m²).

type string Required Discriminator

This property is used to easily identify House VS Apartment

Value is flat.
size integer Required

Area, in square meters (m²)
monthy_rent integer Required

Monthly rent, in dollars ($)
address string Required

Address for the accommodation
floor integer Required
collective_heating_system boolean
elevator boolean

Default value is false.
parking_spots integer

Default value is false.

Responses

200

Accommodation has been created.
300

🚐
404

🌌

POST /accommodation

curl \
 -X POST http://realestate.agency.io/api/v1/accommodation \
 -H "Content-Type: application/json" \
 -d '{"type":"house","size":139,"monthy_rent":799,"address":"246 Bd Saint-Germain, 75007 Paris","garden_size":3300,"roof_tiles_type":"Clay","solar_panels_power":1200,"basement_size":42}'

Request examples

{
  "type": "house",
  "size": 139,
  "monthy_rent": 799,
  "address": "246 Bd Saint-Germain, 75007 Paris",
  "garden_size": 3300,
  "roof_tiles_type": "Clay",
  "solar_panels_power": 1200,
  "basement_size": 42
}

{
  "type": "flat",
  "size": 139,
  "monthy_rent": 799,
  "address": "246 Bd Saint-Germain, 75007 Paris",
  "floor": 2,
  "collective_heating_system": true,
  "elevator": true,
  "parking_spots": 3
}

Request examples

{
  "type": "house",
  "size": 139,
  "monthy_rent": 799,
  "address": "246 Bd Saint-Germain, 75007 Paris",
  "garden_size": 3300,
  "roof_tiles_type": "Clay",
  "solar_panels_power": 1200,
  "basement_size": 42
}

{
  "type": "flat",
  "size": 139,
  "monthy_rent": 799,
  "address": "246 Bd Saint-Germain, 75007 Paris",
  "floor": 2,
  "collective_heating_system": true,
  "elevator": true,
  "parking_spots": 3
}