Google: Calendar freebusy schemas

← Calendar freebusy operations · All schemas

Returns free busy information for a set of calendars — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
calendarExpansionMax	integer	Optional	Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50. Format: int32
groupExpansionMax	integer	Optional	Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100. Format: int32
items	array	Optional	List of calendars and/or groups to query.
items[]	Model	Each item	Expand Returns free busy information for a set of calendars — request body — body items item
timeMax	string	Optional	The end of the interval for the query formatted as per RFC3339. Format: date-time
timeMin	string	Optional	The start of the interval for the query formatted as per RFC3339. Format: date-time
timeZone	string	Optional	Time zone used in the response. Optional. The default is UTC. Default: UTC

Referenced models: Returns free busy information for a set of calendars — request body — body items item

Returns free busy information for a set of calendars — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	The identifier of a calendar or a group.

Returns free busy information for a set of calendars — response body

Field	Type	Presence	Description and constraints
$	object	Root
calendars	object	Optional	List of free/busy information for calendars. Additional keys: see wildcard field
calendars.*	Model	Additional keys	Expand Returns free busy information for a set of calendars — response body — calendars value Free/busy expansions for a single calendar.
groups	object	Optional	Expansion of groups. Additional keys: see wildcard field
groups.*	Model	Additional keys	Expand Returns free busy information for a set of calendars — response body — groups value List of calendars that are members of this group.
kind	string	Optional	Type of the resource ("calendar#freeBusy"). Default: calendar#freeBusy
timeMax	string	Optional	The end of the interval. Format: date-time
timeMin	string	Optional	The start of the interval. Format: date-time

Referenced models: Returns free busy information for a set of calendars — response body — calendars value, Returns free busy information for a set of calendars — response body — groups value

Returns free busy information for a set of calendars — response body — calendars value

Field	Type	Presence	Description and constraints
$	object	Root
busy	array	Optional	List of time ranges during which this calendar should be regarded as busy.
busy[]	Model	Each item	Expand Returns free busy information for a set of calendars — response body — calendars value busy item
errors	array	Optional	Optional error(s) (if computation for the calendar failed).
errors[]	Model	Each item	Expand Returns free busy information for a set of calendars — response body — groups value errors item

Referenced models: Returns free busy information for a set of calendars — response body — groups value errors item, Returns free busy information for a set of calendars — response body — calendars value busy item

Returns free busy information for a set of calendars — response body — calendars value busy item

Field	Type	Presence	Description and constraints
$	object	Root
end	string	Optional	The (exclusive) end of the time period. Format: date-time
start	string	Optional	The (inclusive) start of the time period. Format: date-time

Returns free busy information for a set of calendars — response body — groups value

Field	Type	Presence	Description and constraints
$	object	Root
calendars	array	Optional	List of calendars' identifiers within a group.
calendars[]	string	Each item
errors	array	Optional	Optional error(s) (if computation for the group failed).
errors[]	Model	Each item	Expand Returns free busy information for a set of calendars — response body — groups value errors item

Referenced models: Returns free busy information for a set of calendars — response body — groups value errors item

Returns free busy information for a set of calendars — response body — groups value errors item

Field	Type	Presence	Description and constraints
$	object	Root
domain	string	Optional	Domain, or broad category, of the error.
reason	string	Optional	Specific reason for the error. Some of the possible values are: - "groupTooBig" - The group of users requested is too large for a single query. - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query. - "notFound" - The requested resource was not found. - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.