element <getFreeBusyDaysRequest> (global)
Namespace:
http://schemas.microsoft.com/hs/2001/10/myCalendar
Type:
anonymous complexType (extension of domainStandardMethodParametersType)
Content:
complex, 5 elements
Defined:
globally in myCalendar.xsd; see XML source
Includes:
definitions of 2 elements
Used:
never
XML Representation Summary
<getFreeBusyDaysRequest>
   
Content: 
</getFreeBusyDaysRequest>
Content model elements (5):
calendarType (type calendarLocaleEnum), endTime (type xsd:dateTime), getFreeBlocks (in getFreeBusyDaysRequest), returnIndividualBlocks (in getFreeBusyDaysRequest), startTime (type xsd:dateTime)
Annotation
This function returns a stream of xml fragments defining the user's freeBusy information between two dates. Single events and recurring events within the time window are translated into blocks of free/busy time. <br/><b>getFreeBusyDays</b> only returns the blocks and their associated type. There is no explicit method to return unmerged freeBusy info, that kind of behavior is fully contained within getCalendarDays. <br/>This method follows the precedence order: <ul> <li>Away(OOF), Busy, Tentative, Free</li> <li>Overlapping blocks of the same freeOrBusyStatus kind are coalesced to form larger blocks.</li> <li>Overlapping blocks of different freeOrBusyStatus are overlaid. The events with higher precedence overlay on top (<b>not</b> by starting time).</li> </ul> <br/>For example: <li>Busy from 8 to 9</li> <li>Tentative from 8:30 to 10</li> <li>OOF from 9:30 to 11</li> <li>Free from 10:30 to 12</li> <br/>Merged as: <li>Busy from 8 to 9</li> <li>Tentative from 9 to 9:30</li> <li>OOF from 9:30 to 11</li> <li>Free from 11 to 12</li> <br/>Multiple users' freeBusy information are retrieved by specifying a puid for each user in question. The caller of this function must also specify their own puid, no implicit assumptions are made. <br/>The calling method takes a startDate and an endDate to define the duration over which freebusy information is returned. A third parameter determines if free blocks are explicitly returned. Free blocks are intervals where no calendar object exists. <br/><b>getFreeBusyDays</b> may be used to retrieve multiple calendar data from other users using <li><h:key instance="0" cluster="0" puid="xyz"/></li> in the SOAP headers provided that puid "xyz" is provisioned on the .NET Calendar server, and provided that the user has been granted access in puid "xyz"'s rolelist.
Anonymous Type Detail
Type Derivation Tree
domainStandardMethodParametersType (extension)
  complexType
XML Source (see within schema source)
<xsd:element name="getFreeBusyDaysRequest">
<xsd:annotation>
<xsd:documentation>
This function returns a stream of xml fragments defining the user's
freeBusy information between two dates. Single events and recurring
events within the time window are translated into blocks of free/busy
time.
<br/>
<b>getFreeBusyDays</b>
only returns the blocks and their
associated type. There is no explicit method to return unmerged
freeBusy info, that kind of behavior is fully contained within
getCalendarDays.
<br/>
This method follows the precedence order:
<ul>
<li>Away(OOF), Busy, Tentative, Free</li>
<li>
Overlapping blocks of the same freeOrBusyStatus kind
are coalesced to form larger blocks.
</li>
<li>
Overlapping blocks of different freeOrBusyStatus are
overlaid. The events with higher precedence overlay
on top (
<b>not</b>
by starting time).
</li>
</ul>
<br/>
For example:
<li>Busy from 8 to 9</li>
<li>Tentative from 8:30 to 10</li>
<li>OOF from 9:30 to 11</li>
<li>Free from 10:30 to 12</li>
<br/>
Merged as:
<li>Busy from 8 to 9</li>
<li>Tentative from 9 to 9:30</li>
<li>OOF from 9:30 to 11</li>
<li>Free from 11 to 12</li>
<br/>
Multiple users' freeBusy information are retrieved
by specifying a puid for each user in question. The caller of
this function must also specify their own puid, no implicit
assumptions are made.
<br/>
The calling method takes a startDate and an endDate to
define the duration over which freebusy information is returned.
A third parameter determines if free blocks are explicitly
returned. Free blocks are intervals where no calendar object
exists.
<br/>
<b>getFreeBusyDays</b>
may be used to retrieve multiple calendar data from
other users using
<li>&lt;h:key instance="0" cluster="0" puid="xyz"/&gt;</li>
in the SOAP headers provided that puid "xyz" is provisioned on the .NET Calendar
server, and provided that the user has been granted access in puid "xyz"'s rolelist.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="domainStandardMethodParametersType">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="getFreeBlocks" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
This boolean causes .NET Calendar to explicitly return
free time as freeBusy blocks. By default, free blocks are not returned.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="returnIndividualBlocks" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
This boolean causes .NET Calendar not to coalesce/merge freeBusy information.
By default, freeBusy information is merged.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
Content Element Detail (all declarations; 5/5)
calendarType
Type:
calendarLocaleEnum, simple content
Defined:
locally within domainStandardMethodParametersType complexType
Optional calendar type to return. Defaults to Gregorian.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="calendarType" type="calendarLocaleEnum">
<xsd:annotation>
<xsd:documentation>
Optional calendar type to return. Defaults to Gregorian.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
endTime
Type:
xsd:dateTime, predefined, simple content
Defined:
locally within domainStandardMethodParametersType complexType
The ending time window to retrieve calendar objects. This dateTime also contains the timeZone to retrieve the calendar information in. It must be the same timeZone as startTime.
XML Source (see within schema source)
<xsd:element name="endTime" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
The ending time window to retrieve calendar objects.
This dateTime also contains the timeZone to retrieve the
calendar information in. It must be the same timeZone as
startTime.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
getFreeBlocks
Type:
xsd:boolean, predefined, simple content
Defined:
locally within (this) getFreeBusyDaysRequest element
This boolean causes .NET Calendar to explicitly return free time as freeBusy blocks. By default, free blocks are not returned.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="getFreeBlocks" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
This boolean causes .NET Calendar to explicitly return
free time as freeBusy blocks. By default, free blocks are not returned.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
returnIndividualBlocks
Type:
xsd:boolean, predefined, simple content
Defined:
locally within (this) getFreeBusyDaysRequest element
This boolean causes .NET Calendar not to coalesce/merge freeBusy information. By default, freeBusy information is merged.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="returnIndividualBlocks" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
This boolean causes .NET Calendar not to coalesce/merge freeBusy information.
By default, freeBusy information is merged.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
startTime
Type:
xsd:dateTime, predefined, simple content
Defined:
locally within domainStandardMethodParametersType complexType
The starting time window of calendar objects to retrieve. This dateTime also contains the timeZone to retrieve the calendar information in.
XML Source (see within schema source)
<xsd:element name="startTime" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
The starting time window of calendar objects to retrieve.
This dateTime also contains the timeZone to retrieve the
calendar information in.
</xsd:documentation>
</xsd:annotation>
</xsd:element>