FairePlace Property Management API

Rooms

Endpointhttps://api.faireplace.com/api

Room management

List rooms for estate

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms

List rooms for estate › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

List rooms for estate › Responses

object[]

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/places/{place_id}/estates/{estate_id}/rooms

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "carrez_surface": {},
    "habitable_surface": {},
    "designation": {},
    "type_room_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create room for estate

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms

Create room for estate › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

Create room for estate › Request Body

type_room_id

string · uuid · required

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

Create room for estate › Responses

Created

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

POST/places/{place_id}/estates/{estate_id}/rooms

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms \
  --header 'Content-Type: application/json' \
  --data '
{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get room by ID

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Get room by ID › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

room_id

string · uuid · required

Get room by ID › Responses

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/places/{place_id}/estates/{estate_id}/rooms/{room_id}

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update room

PUT

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Update room › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

room_id

string · uuid · required

Update room › Request Body

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

Update room › Responses

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

PUT/places/{place_id}/estates/{estate_id}/rooms/{room_id}

curl --request PUT \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete room

DELETE

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Delete room › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

room_id

string · uuid · required

Delete room › Responses

No Content

No data returned

DELETE/places/{place_id}/estates/{estate_id}/rooms/{room_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id

shell

Example Responses

No example specified for this content type

Places Equipment

FairePlace Property Management API

Rooms

Endpointhttps://api.faireplace.com/api

Room management

List rooms for estate

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms

List rooms for estate › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

List rooms for estate › Responses

object[]

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/places/{place_id}/estates/{estate_id}/rooms

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "carrez_surface": {},
    "habitable_surface": {},
    "designation": {},
    "type_room_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create room for estate

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms

Create room for estate › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

Create room for estate › Request Body

type_room_id

string · uuid · required

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

Create room for estate › Responses

Created

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

POST/places/{place_id}/estates/{estate_id}/rooms

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms \
  --header 'Content-Type: application/json' \
  --data '
{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get room by ID

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Get room by ID › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

room_id

string · uuid · required

Get room by ID › Responses

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/places/{place_id}/estates/{estate_id}/rooms/{room_id}

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update room

PUT

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Update room › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

room_id

string · uuid · required

Update room › Request Body

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

Update room › Responses

id

string | null · uuid

estate_id

string | null · uuid

carrez_surface

number | null

habitable_surface

number | null

designation

string | null

type_room_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

PUT/places/{place_id}/estates/{estate_id}/rooms/{room_id}

curl --request PUT \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "carrez_surface": {},
  "habitable_surface": {},
  "designation": {},
  "type_room_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete room

DELETE

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Delete room › path Parameters

place_id

string · uuid · required

estate_id

string · uuid · required

room_id

string · uuid · required

Delete room › Responses

No Content

No data returned

DELETE/places/{place_id}/estates/{estate_id}/rooms/{room_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id

shell

Example Responses

No example specified for this content type

Places Equipment