Get a floor plan

GET 
/api/v1/businesses/:id/floor_plans/:floor_plan_id

Return floor plan for specific business

Request

Path Parameters

id stringrequired
floor_plan_id stringrequired

Query Parameters

include string

Include associations (delimited with comma). Available associations: tables

Responses

200

Return floor plan for specific business

application/vnd.api+json

Schema

Schema

data

object

required

id stringrequired

type stringrequired

Possible values: [floor_plans]

links

object

required

self stringrequired

attributes

object

required

name string

Default value: Main

height int32

Default value: 1000

width int32

Default value: 1000

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "floor_plans",
    "links": {
      "self": "string"
    },
    "attributes": {
      "name": "Main",
      "height": 1000,
      "width": 1000
    }
  }
}

Loading...