Floors

A floor is an entity representing a certain level of a building. More details here.
The floor object
id integer
Floor identifier
building_id integer
Building identifier (retrieve all you buildings to know their identifiers)
project_id (Deprecated) integer
(Deprecated, use building_id)
Building identifier (retrieve all you buildings to know their identifiers)
level integer
Floor level. Represents the phisical level of the building
E.g. If the building has a basement, its level will be -1
level_height float
Floor level height in meters. It is 0 by default
Represents the distance between the floor and the ground
More details here
created_at datetime
Time when the floor was created
updated_at datetime
Last time when the floor was updated
maps object
Floorplan
Child attributes
scale float
Floorplan image scale in pixels/meters
Example:
Buildings dimensions: 72.77 meters long by 43.27 meters wide
Building image dimensions: 1264 pixels long by 758 pixels wide
Scale: 1264 pixels / 72.77 meters = 17.3698 pixels/meters
map_url string
Floorplan image url
Example Response
{
  "id": 995,
  "building_id": 630,
  "project_id": 630,
  "level": -1,
  "level_height":10.0,
  "created_at": "2016-09-16T09:45:20.098+02:00",
  "updated_at": "2016-09-16T09:45:20.098+02:00",
  "maps": {
    "scale": 20.1388,
    "map_url": "http://dashboard.situm.es/uploads/situm/floor/map/995/80eadc8f-df52-48e1-aa0b-2e5abd1262dd.PNG",
    "map_id": "80eadc8f-df52-48e1-aa0b-2e5abd1262dd.PNG",
  },
}

Returns a list of floors of a building

Each floor resource contains, among other information, the physical level of the floor, the floorplan image and its scale (pixels/meter).
Parameters
X-API-EMAIL required
The email of the user
X-API-KEY required
The API key of the user
building_id required path param
Building identifier (retrieve all your buildings to know their identifiers)
Returns
Returns an array of floor objects.
Error Status Codes
Request url
https://dashboard.situm.es/api/v1/buildings/:building_id/floors
*Deprecated: https://dashboard.situm.es/api/v1/projects/:building_id/floors (supported until SDK 4.0)
Curl
curl -H 'Content-Type: application/json' -H 'X-API-EMAIL: user@example.com' -H 'X-API-KEY: T9NP2lzk+jSI/Oi5DG6ODk57O0pZXdx4' "https://dashboard.situm.es/api/v1/buildings/:building_id/floors"
Response body
[
  {
    id: 995,
    building_id: 630,
    project_id: 630,
    level: -1,
    level_height:10.0,
    created_at: "2016-09-16T09:45:20.098+02:00",
    updated_at: "2016-09-16T09:45:20.098+02:00",
    maps: {
      scale: 20.138829737835003,
      map_url: "http://dashboard.situm.es/uploads/situm/floor/map/995/80eadc8f-df52-48e1-aa0b-2e5abd1262dd.PNG",
      map_id: "80eadc8f-df52-48e1-aa0b-2e5abd1262dd.PNG",
    },
  },
  {

    id: 992,
    building_id: 630,
    project_id: 630,
    level: 0,
    level_height:10.0,
    created_at: "2016-09-16T09:44:31.206+02:00",
    updated_at: "2016-09-16T09:44:31.206+02:00",
    maps: {
      scale: 20.138829737835003,
      map_url: "http://dashboard.situm.es/uploads/situm/floor/map/992/04d89b6f-652d-4c52-9ada-a456e80352e9.PNG",
      map_id: "04d89b6f-652d-4c52-9ada-a456e80352e9.PNG",
    },
  },
  {
    id: 993,
    building_id: 630,
    project_id: 630,
    level: 1,
    level_height:10.0,
    created_at: "2016-09-16T09:45:06.349+02:00",
    updated_at: "2016-09-16T09:45:06.349+02:00",
    maps: {
      scale: 20.138829737835003,
      map_url: "http://dashboard.situm.es/uploads/situm/floor/map/993/f3242123-9f1a-4fc0-8a72-65cec5952e7e.png",
      map_id: "f3242123-9f1a-4fc0-8a72-65cec5952e7e.png",
    },
  },
  {
    id: 994,
    building_id: 630,
    project_id: 630,
    level: 2,
    level_height:10.0,
    created_at: "2016-09-16T09:45:12.715+02:00",
    updated_at: "2016-09-16T09:45:12.715+02:00",
    maps: {
      scale: 20.138829737835003,
      map_url: "http://dashboard.situm.es/uploads/situm/floor/map/994/142f3c89-c2be-46fc-9d3c-09bc18784364.png",
      map_id: "142f3c89-c2be-46fc-9d3c-09bc18784364.png",
    },
  }
]

Details of a floor

Each floor resource contains, among other information, the physical level of the floor, the floorplan image and its scale (pixels/meter).
Parameters
X-API-EMAIL required
The email of the user
X-API-KEY required
The API key of the user
id required path param
Floor identifier (retrieve all your floors to know their identifiers)
Returns
Returns the floor object.
Error Status Codes
Request url
https://dashboard.situm.es/api/v1/floors/:id
Curl
curl -H 'Content-Type: application/json' -H 'X-API-EMAIL: user@example.com' -H 'X-API-KEY: T9NP2lzk+jSI/Oi5DG6ODk57O0pZXdx4' "https://dashboard.situm.es/api/v1/floors/:id"
Response body
{
  "id": 995,
  "building_id": 630,
  "project_id": 630,
  "level": -1,
  "level_height":10.0,
  "created_at": "2016-09-16T09:45:20.098+02:00",
  "updated_at": "2016-09-16T09:45:20.098+02:00",
  "maps": {
    "scale": 20.1388,
    "map_url": "http://dashboard.situm.es/uploads/situm/floor/map/995/80eadc8f-df52-48e1-aa0b-2e5abd1262dd.PNG",
    "map_id": "80eadc8f-df52-48e1-aa0b-2e5abd1262dd.PNG",
  },
}