cd:freeBusy Element

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Contains consecutive calendar blocks, showing free-busy intervals of a specified duration from a specified starting time.

Syntax

<freeBusy xmlns="http://schemas.microsoft.com/2006/09/sip/calendarData"
                startTime="..." granularity="..." encodingVersion="..."> 
   ...{base64(a binary stream)}
</freeBusy>

Attributes

Attribute

Data Type

Description

startTime

xs:dateTime

Starting time in UTC. Required

granularity

xs:duration

Duration of time slots in minutes showing free or busy on calendar. See Remarks below. Required

encodingVersion

xs:decimal

Encoding version number. Required

Tag Content

Default Value

Data Type

Description

None

xs:base64Binary

The free/busy data. For more information, see Remarks.

Parent Element

Element

Description

cd:calendarData

The calendarData element.

Child Elements

None

Remarks

Free busy data, the value of this element, is a Base64 encoded string on the stream of binary bits. Every 2 bits represent a calendar block of the duration defined by the granularity value in minutes. Data starts from the given startTime in UTC. Calendar block types are encoded as follows:

  • 00, Free (Fr)

  • 01, Tentative (Te)

  • 10, Busy (Bu)

  • 11, Out of facility (Oo)

For example, the startTime attribute value can be "2007-09-01T00:00:00Z"; a granularity value of "PT15M" shows calendar blocks as fifteen-minute intervals; the calendar blocks of the following order

FrFrFrFrFrBuBuBuBuTeTeTeTeOoOoOoOoFrFr

correspond to a bit stream of

00000000001010101001010101111111110000

The free-busy data shown by the value of a freeBusy element is the Base64 encoded value of the above bit stream.

Examples

XML Example of the freeBusy Element

<?xml version="1.0" encoding="utf-8" ?>
<calendarData xmlns="http://schemas.microsoft.com/2006/09/sip/calendarData" mailboxID="bob@contoso.com">
  <freeBusy startTime="2007-10-27T07:00:00Z" granularity="PT15M"     encodingVersion="1">AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABVAABVAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAqgAAAAAAVQAA</freeBusy> 
</calendarData>