{"_id":"5866c7773e21a72d0029a2a7","parentDoc":null,"version":{"_id":"5435693035740020002a1c1f","__v":14,"project":"5435693035740020002a1c1c","createdAt":"2014-10-08T16:41:20.702Z","releaseDate":"2014-10-08T16:41:20.702Z","categories":["5435693035740020002a1c20","551c03c1ff892b3700d1c57a","551ca3927405910d00900a59","551cac6448564a2f0024d89e","551cb4d848564a2f0024d8a3","551cb52db7a32b3b00d1ef78","5526e2064a7ac121004c6073","5526e5147d4a4417009516b3","5526e9877d4a4417009516bb","5528362cd9e1db2d00cd924d","5580240ebe698419008f2ba2","5580a7dabe698419008f2db6","568161799de23c0d00c54750","5866c905a2cbb31900f6f1aa"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"543568c135740020002a1c10","category":{"_id":"551c03c1ff892b3700d1c57a","pages":["551c056aefc11923006421e8","551c0b2befc11923006421f3","551c0ce223a1ee190034d0ff","551ca30f7405910d00900a57","551ca412b7a32b3b00d1ef69","551ca4e335f9812f008ccd31","551cac0d35f9812f008ccd38","551cae3bd65a6d19007a8e6a","551caef7b7a32b3b00d1ef70","551cb06448564a2f0024d8a0","551cb24435f9812f008ccd3c","551cb2a8d65a6d19007a8e75","551cb4cfb7a32b3b00d1ef76","552926c5ceedaa0d00bc5c71"],"version":"5435693035740020002a1c1f","__v":14,"project":"5435693035740020002a1c1c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-01T14:42:09.907Z","from_sync":false,"order":7,"slug":"spaces","title":"Spaces"},"project":"5435693035740020002a1c1c","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-30T20:45:43.570Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET /v1.0/spaces/50/state HTTP/1.1\nHost: api.robinpowered.com\nContent-Type: application/json\nAuthorization: Access-Token :accessToken\n","language":"http"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"status_code\": 200,\n    \"status\": \"OK\",\n    \"message\": \"\",\n    \"more_info\": {}\n  },\n  \"data\": {\n    \"availability\": \"available\",\n    \"present\": 1,\n    \"next_busy_change\": \"2016-12-31T18:30:00Z\"\n  }\n}","name":""},{"code":"{\n  \"meta\": {\n    \"status_code\": 404,\n    \"status\": \"NOT_FOUND\",\n    \"message\": \"\",\n    \"more_info\": {}\n  },\n  \"data\": {}\n}","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"5526eb27d7ea1c2300e58a5c","ref":"","in":"path","required":true,"desc":"The ID of the space","default":"","type":"int","name":"id"}],"url":"/spaces/:id/state"},"isReference":true,"order":13,"body":"The space state entity describes the current availability state of the space. The table below describes the properties of this entity:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`availability`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The availability of the space. Either `available`, `booked` or `in_use` or `disabled`. Booked indicates that the room is reserved or imminently reserved. In use implies that there is an active meeting occurring.\",\n    \"1-0\": \"`present`\",\n    \"1-1\": \"Integer\",\n    \"1-2\": \"The amount of users or devices present within the space.\",\n    \"2-0\": \"`next_busy_change`\",\n    \"2-1\": \"DateTime\",\n    \"2-2\": \"An ISO-8601 timestamp that represents the next time the room will switch from `available` to `booked` or `in_use` or vice versa.\\n\\nThis value can be useful for expressing information in the form of:\\n\\n\\\"This room is busy until 5pm.\\\" or \\\"This room is available until 3:30pm.\\\"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"Gets the availability state for the space.","slug":"get-space-state","type":"endpoint","title":"/spaces/:id/state"}

get/spaces/:id/state

Gets the availability state for the space.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
The ID of the space

Examples


Result Format


Documentation

The space state entity describes the current availability state of the space. The table below describes the properties of this entity: [block:parameters] { "data": { "0-0": "`availability`", "0-1": "String", "0-2": "The availability of the space. Either `available`, `booked` or `in_use` or `disabled`. Booked indicates that the room is reserved or imminently reserved. In use implies that there is an active meeting occurring.", "1-0": "`present`", "1-1": "Integer", "1-2": "The amount of users or devices present within the space.", "2-0": "`next_busy_change`", "2-1": "DateTime", "2-2": "An ISO-8601 timestamp that represents the next time the room will switch from `available` to `booked` or `in_use` or vice versa.\n\nThis value can be useful for expressing information in the form of:\n\n\"This room is busy until 5pm.\" or \"This room is available until 3:30pm.\"" }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}