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.

Properties

has_presence

boolean

This property is only returned for FreeBusySpace entities. It describes whether there is any presence currently within the space.

space

Space

This property is only returned for FreeBusySpace entities. It represents the space that the FreeBusy is describing availability for.

user

User

This property is only returned for FreeBusyUser entities. It represents the user that the FreeBusy is describing availability for.

busy

Busy[]

Describes the times that the entity is busy for.

Busy Entity

from

String

The date and time of the lower bound of the busy block, represented as an ISO-8601 date.

to

String

The date and time of the upper bound of the busy block, represented as an ISO-8601 date.

events

Event[]

A list of events that make up the busy times within the busy block.

Example

{
  "has_presence": false,
  "space": {
    "id": 50,
    "location_id": 10,
    "name": "Conference Room"
    // ...
  },
  "busy": [
    {
      "from": "2018-03-10T16:00:00+0000",
      "to": "2018-03-10T17:00:00+0000",
      "events": [
        {
          "id": "17568519_20161114T113000Z",
          "series_id": "17568519",
          "recurrence_id": "20161114T113000Z",
          "uid": "[email protected]",
          "space_id": 50,
          "start": {
            "date_time": "2018-03-10T16:00:00+0000",
            "time_zone": "UTC"
          },
          "end": {
            "date_time": "2018-03-10T17:00:00+0000",
            "time_zone": "UTC"
          },  
        }
      ]
    },
    {
      "from": "2018-03-13T15:50:00+0000",
      "to": "2018-03-13T16:00:00+0000",
      "events": [
        {
          "id": "35655066_20180313T155000Z",
          "series_id": "35655066",
          "recurrence_id": "20180313T155000Z",
          "uid": "[email protected]",
          "space_id": 50,
          "start": {
            "date_time": "2018-03-13T11:50:00-0400",
            "time_zone": "America/New_York"
          },
          "end": {
            "date_time": "2018-03-13T12:00:00-0400",
            "time_zone": "America/New_York"
          },
        }
      ]
    }
  ]
}