{"_id":"5828aa35a911ba0f0069fd1a","category":{"_id":"551ca3927405910d00900a59","pages":["551ca655b7a32b3b00d1ef6a","551cb8f35de8de3900d8db0d","551cb97f5de8de3900d8db0f","55293316a15e530d00af3cb3","55882c89eb5f2421003f9a1c","55883030eb5f2421003f9a2f"],"project":"5435693035740020002a1c1c","version":"5435693035740020002a1c1f","__v":6,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-02T02:04:02.634Z","from_sync":false,"order":2,"slug":"api-resources","title":"API Resources"},"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"},"__v":0,"githubsync":"","parentDoc":null,"project":"5435693035740020002a1c1c","user":"543568c135740020002a1c10","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-13T18:00:21.800Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"FreeBusy entities help indicate the availability of spaces and users during a given period of time. There are slight differences to the `FreeBusyUser` and `FreeBusySpace` entities, described in the table below.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`has_presence`\",\n    \"0-1\": \"boolean\",\n    \"0-2\": \"This property is only returned for `FreeBusySpace` entities. It describes whether there is any presence currently within the space.\",\n    \"1-0\": \"`space`\",\n    \"1-1\": \"[Space](doc:space)\",\n    \"1-2\": \"This property is only returned for `FreeBusySpace` entities. It represents the space that the FreeBusy is describing availability for.\",\n    \"3-0\": \"`busy`\",\n    \"3-1\": \"[Busy](https://docs.robinpowered.com/v1.0/docs/freebusy#busy-entity)[]\",\n    \"3-2\": \"Describes the times that the entity is busy for.\",\n    \"2-0\": \"`user`\",\n    \"2-1\": \"[User](doc:user)\",\n    \"2-2\": \"This property is only returned for `FreeBusyUser` entities. It represents the user that the FreeBusy is describing availability for.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Busy Entity\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`from`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The date and time of the lower bound of the busy block, represented as an ISO-8601 date.\",\n    \"1-0\": \"`to`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The date and time of the upper bound of the busy block, represented as an ISO-8601 date.\",\n    \"2-0\": \"`events`\",\n    \"2-1\": \"[Event](doc:event)[]\",\n    \"2-2\": \"A list of events that make up the busy times within the busy block.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"has_presence\\\": false,\\n  \\\"space\\\": {\\n    \\\"id\\\": 50,\\n    \\\"location_id\\\": 10,\\n    \\\"name\\\": \\\"Conference Room\\\"\\n    // ...\\n  },\\n  \\\"busy\\\": [\\n    {\\n      \\\"from\\\": \\\"2018-03-10T16:00:00+0000\\\",\\n      \\\"to\\\": \\\"2018-03-10T17:00:00+0000\\\",\\n      \\\"events\\\": [\\n        {\\n          \\\"id\\\": \\\"17568519_20161114T113000Z\\\",\\n          \\\"series_id\\\": \\\"17568519\\\",\\n          \\\"recurrence_id\\\": \\\"20161114T113000Z\\\",\\n          \\\"uid\\\": \\\"3ujog6avl5cvtgigvsllp7h0og:::at:::google.com\\\",\\n          \\\"space_id\\\": 50,\\n          \\\"start\\\": {\\n            \\\"date_time\\\": \\\"2018-03-10T16:00:00+0000\\\",\\n            \\\"time_zone\\\": \\\"UTC\\\"\\n          },\\n          \\\"end\\\": {\\n            \\\"date_time\\\": \\\"2018-03-10T17:00:00+0000\\\",\\n            \\\"time_zone\\\": \\\"UTC\\\"\\n          },  \\n        }\\n      ]\\n    },\\n    {\\n      \\\"from\\\": \\\"2018-03-13T15:50:00+0000\\\",\\n      \\\"to\\\": \\\"2018-03-13T16:00:00+0000\\\",\\n      \\\"events\\\": [\\n        {\\n          \\\"id\\\": \\\"35655066_20180313T155000Z\\\",\\n          \\\"series_id\\\": \\\"35655066\\\",\\n          \\\"recurrence_id\\\": \\\"20180313T155000Z\\\",\\n          \\\"uid\\\": \\\"lue7n8iljrpq229dkcr11tvl8g@google.com\\\",\\n          \\\"space_id\\\": 50,\\n          \\\"start\\\": {\\n            \\\"date_time\\\": \\\"2018-03-13T11:50:00-0400\\\",\\n            \\\"time_zone\\\": \\\"America/New_York\\\"\\n          },\\n          \\\"end\\\": {\\n            \\\"date_time\\\": \\\"2018-03-13T12:00:00-0400\\\",\\n            \\\"time_zone\\\": \\\"America/New_York\\\"\\n          },\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Describes whether a related entity is available (free) or unavailable (busy)","slug":"freebusy","type":"basic","title":"FreeBusy"}

FreeBusy

Describes whether a related entity is available (free) or unavailable (busy)

FreeBusy entities help indicate the availability of spaces and users during a given period of time. There are slight differences to the `FreeBusyUser` and `FreeBusySpace` entities, described in the table below. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "0-0": "`has_presence`", "0-1": "boolean", "0-2": "This property is only returned for `FreeBusySpace` entities. It describes whether there is any presence currently within the space.", "1-0": "`space`", "1-1": "[Space](doc:space)", "1-2": "This property is only returned for `FreeBusySpace` entities. It represents the space that the FreeBusy is describing availability for.", "3-0": "`busy`", "3-1": "[Busy](https://docs.robinpowered.com/v1.0/docs/freebusy#busy-entity)[]", "3-2": "Describes the times that the entity is busy for.", "2-0": "`user`", "2-1": "[User](doc:user)", "2-2": "This property is only returned for `FreeBusyUser` entities. It represents the user that the FreeBusy is describing availability for." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Busy Entity" } [/block] [block:parameters] { "data": { "0-0": "`from`", "0-1": "String", "0-2": "The date and time of the lower bound of the busy block, represented as an ISO-8601 date.", "1-0": "`to`", "1-1": "String", "1-2": "The date and time of the upper bound of the busy block, represented as an ISO-8601 date.", "2-0": "`events`", "2-1": "[Event](doc:event)[]", "2-2": "A list of events that make up the busy times within the busy block." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Example" } [/block] [block:code] { "codes": [ { "code": "{\n \"has_presence\": false,\n \"space\": {\n \"id\": 50,\n \"location_id\": 10,\n \"name\": \"Conference Room\"\n // ...\n },\n \"busy\": [\n {\n \"from\": \"2018-03-10T16:00:00+0000\",\n \"to\": \"2018-03-10T17:00:00+0000\",\n \"events\": [\n {\n \"id\": \"17568519_20161114T113000Z\",\n \"series_id\": \"17568519\",\n \"recurrence_id\": \"20161114T113000Z\",\n \"uid\": \"3ujog6avl5cvtgigvsllp7h0og@google.com\",\n \"space_id\": 50,\n \"start\": {\n \"date_time\": \"2018-03-10T16:00:00+0000\",\n \"time_zone\": \"UTC\"\n },\n \"end\": {\n \"date_time\": \"2018-03-10T17:00:00+0000\",\n \"time_zone\": \"UTC\"\n }, \n }\n ]\n },\n {\n \"from\": \"2018-03-13T15:50:00+0000\",\n \"to\": \"2018-03-13T16:00:00+0000\",\n \"events\": [\n {\n \"id\": \"35655066_20180313T155000Z\",\n \"series_id\": \"35655066\",\n \"recurrence_id\": \"20180313T155000Z\",\n \"uid\": \"lue7n8iljrpq229dkcr11tvl8g@google.com\",\n \"space_id\": 50,\n \"start\": {\n \"date_time\": \"2018-03-13T11:50:00-0400\",\n \"time_zone\": \"America/New_York\"\n },\n \"end\": {\n \"date_time\": \"2018-03-13T12:00:00-0400\",\n \"time_zone\": \"America/New_York\"\n },\n }\n ]\n }\n ]\n}", "language": "json" } ] } [/block]