Skip to content
Docs
Select language:English

/api/v1/floor-plans/{id}/apply

POST
/api/v1/floor-plans/{id}/apply
curl --request POST \
  --url https://example.com/api/v1/floor-plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/apply \
  --header 'Content-Type: application/json' \
  --data '{ "version": "example", "keepPlan": true, "floors": [ { "key": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example" } ], "rooms": [ { "key": "example", "floorKey": "example", "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "kind": "room", "surface": "wood", "x": 1, "z": 1, "w": 1, "d": 1 } ] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
Any of:
string
<= 40 characters
keepPlan
required
boolean
floors
required
Array<object>
<= 6 items
object
key
required
string
>= 1 characters <= 40 characters
id
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
>= 1 characters <= 120 characters
rooms
required
Array<object>
>= 1 items <= 60 items
object
key
required
string
>= 1 characters <= 40 characters
floorKey
required
Any of:
string
>= 1 characters <= 40 characters
placeId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
>= 1 characters <= 120 characters
kind
required
string
Allowed values: room balcony terrace garden
surface
required
string
Allowed values: wood tile concrete deck grass
x
required
integer
<= 100000
z
required
integer
<= 100000
w
required
integer
>= 100 <= 10000
d
required
integer
>= 100 <= 10000

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
version
required
string | null
rooms
required
Array<object>
object
key
required
string
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
floors
required
Array<object>
object
key
required
string
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Examplegenerated
{
  "version": "example",
  "rooms": [
    {
      "key": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "floors": [
    {
      "key": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}