calendarData/freeBusy Element
Contains a contiguous calendar block, showing free-busy intervals of a specified duration from a specified starting time.
calendarData
freeBusy Element
<freeBusy xmlns="https://schemas.microsoft.com/2006/09/sip/calendarData"
startTime="dateTime" granularity="duration" encodingVersion="decimal">
A Base64 encode string of a binary stream
</freeBusy>
base64Binary
Attributes and Elements
The following sections describe attributes, child elements, and parent elements.
Attributes
Attribute |
Description |
---|---|
[anyAttr] |
Optional custom attribute of any name in any namespace |
encodingVersion |
Required attribute of the xs:duration type specifying the encoding version of the element value. |
granularity |
Required attribute of the xs:duration type specifying the smallest timeslot period as the unit of a contiguous block of time known as the freeBusy block. |
startTime |
Required attribute of the xs:dateTime type specifying the beginning point of time when the freeBusy block starts. |
Child Elements
None
Parent Elements
Element |
Description |
---|---|
The calendarData category instance containing this freeBusy data. |
Text Value
Base64 encoded value of the binary stream.
Remarks
This element contains a user’s free-busy timeslots specified in the underlying Exchange Server. The value of this element represents a contiguous timeslots with the unit length specified by the granularity attribute and the starting time by the startTime attribute. Each timeslot is represented by 2 bits. There are four types of timeslots:
Free timeslot
The binary value of a Free timeslot is 00.Tentative timeslot
The binary value of a Tentative timeslot is 01.Busy timeslot
The binary value of a Busy timeslot is 10.Out of Office timeslot
The binary value of an Out of Office timeslot is 11.
For example, given a granularity value of "PT15M", each timeslot spans 15 minutes and a contiguous block consisting of
a busy period of 60 minutes, 10101010
a free period of 75 minutes, 0000000000
a tentative period of 60 minutes, 01010101
an Out of Office period of 60 minutes, 11111111, and
another free period of 30 minutes, 0000
is thus represented by a bit stream of 10101010000000000001010101111111110000. Converting this bit stream to a Base64 encoded string yields the value of the freeBusy element.
Example
This is the description for a Code Example.
<calendarData xmlns="https://schemas.microsoft.com/2006/09/sip/calendarData" mailboxID="bob@contoso.com">
<freeBusy xmlns="https://schemas.microsoft.com/exchange/services/2006/types"
startTime="0001-01-01T00:00:00"
granularity="granularity"
encodingVersion="1"
anyAttr="anyattr">AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABVAABVAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAqgAAAAAAVQAA</freeBusy>
</calendarData>
Element Information
Namespace |
https://schemas.microsoft.com/2006/09/sip/calendarData |
Schema Name |
calendarData |
Validation File |
calendarData.xsd, calendardatatypes.xsd |
Can be Empty |
True |