calendarData

Article
01/20/2015

Holds calendar data obtained from an integrated Exchange Server.

<calendarData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns="https://schemas.microsoft.com/2006/09/sip/calendarData"
    mailboxID="xs:anyURI"
    majorVersion="xs:unsignedInt"
    minorVersion="xs:unsignedInt"
    anyAttr="anyattr">
    <WorkingHours xmlns="https://schemas.microsoft.com/exchange/services/2006/types">......</WorkingHours>
    <freeBusy xmlns="https://schemas.microsoft.com/exchange/services/2006/types"
        startTime="0001-01-01T00:00:00" granularity="granularity" encodingVersion="0" anyAttr="anyattr">......</freeBusy>
    <ct:delimiter xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes" />
    <[any] >Any element</[any]>
    <ct:end xmlns="https://schemas.microsoft.com/2006/09/sip/commontypes" />
    <ct:extension xmlns="https://schemas.microsoft.com/2006/09/sip/commontypes">
        <[any] >any element in any namespace</[any]>
    </ct:extension>
</calendarData>

calendarType

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
mailBoxID	Required attribute to hold the SMTP address of the user whose calendar data is contained in this element. For example, "mary@contoso.com"
majorVersion	Optional attribute to specify schema-dependent major version information.
minorVersion	Optional attribute to specify schema-dependent minor version information.
anyAttr	Optional custom attribute of any name and namespace

Child Elements

Element	Occurrence	Description
WorkingHours Element	0 or 1	A user’s working-hours information as specified in the underlying Exchange Server. Each calendarData instance can have either a WorkingHours or freeBusy child element, but not both.
calendarData/freeBusy Element	0 or 1	A user’s free-busy time slots as specified in the underlying Exchange Server. Each calendarData instance can have either a WorkingHours or freeBusy child element, but not both.
ct:delimiter	0 or more	An empty element, of the CommonTypes (ct) namespace, to mark the start of a schema extension to its parent element. Elements describing the extension are enclosed between a ct:delimiter and ct:end elements or between two ct:delimiter elements.
ct:end	0 or 1	An empty element, of the CommonTypes (ct) namespace, to mark the end of all the schema extensions to its parent element.
ct:extension	0 or more	An element, of the CommonTypes (ct) namespace, to hold any elements of any namespace as an application-defined custom extension to the parent element.
[any]	0 or more	A custom element describing an extension to its parent element. When enclosed between a ct:delimiter element and a ct:end element or between two ct:delimiter elements, this element serves to describe a schema extension and can have any name in the namespace of its parent element. When contained in an ct:extension element, this element describes the application-defined custom extension and can have any name in any namespace.

Parent Elements

Element	Description
None	This is a top-level element containing the value of a calendarData enhanced presence category instance

Text Value

This element does not have any text value.

Remarks

A calendarData category instance element can contain either a WorkingHours child element or a freeBusy child element or both. Microsoft Lync 2010 uses separate calendarData elements for WorkingHours and freeBusy. It can be an empty element, especially when used to block remote users from accessing the local user’s calendar data.

Example

The following XML code snippet of a calendarData category instance shows the working hours of a contact (bob@contoso.com) consist of Monday through Friday between 8:00 and 17:00 in the US Pacific Time Zone.

<?xml version="1.0" encoding="utf-8" ?>
<calendarData xmlns="https://schemas.microsoft.com/2006/09/sip/calendarData" mailboxID="bob@contoso.com">
  <WorkingHours xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
    <TimeZone>
      <Bias>480</Bias>
      <StandardTime>
        <Bias>0</Bias>
        <Time>02:00:00</Time>
        <DayOrder>1</DayOrder>
        <Month>11</Month>
        <DayOfWeek>Sunday</DayOfWeek>
      </StandardTime>
      <DaylightTime>
        <Bias>60</Bias>
        <Time>02:00:00</Time>
        <DayOrder>2</DayOrder>
        <Month>3</Month>
        <DayOfWeek>Sunday</DayOfWeek>
      </DaylightTime>
    </TimeZone>
    <WorkingPeriodArray>
      <WorkingPeriod>
        <DayOfWeek>Monday Tuesday Wednesday Thursday Friday</DayOfWeek>
        <StartTimeInMinutes>480</StartTimeInMinutes>
        <EndTimeInMinutes>1020</EndTimeInMinutes>
      </WorkingPeriod>
    </WorkingPeriodArray>
  </WorkingHours> 
</calendarData>

Lync 2010 uses a separate calendarData element for WorkingHours and freeBusyData.

The following XML snippet of a calendarData category instance contains a freeBusy data.

<calendarData xmlns="https://schemas.microsoft.com/2006/09/sip/calendarData" mailboxID="bob@contoso.com">
   <freeBusy startTime="2009-10-27T07:00:00Z" 
     granularity="PT15M" 
     encodingVersion="1" >AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABVAABVAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAqgAAAAAAVQAA</freeBusy> 
</calendarData>

The base64 encoded string value corresponds to a contiguous timeslots having the unit length of 15 minutes and the total length of 96 hours. The starting time corresponds to the midnight Pacific Daylight Time, October 27th, 2009.

Element Information

Namespace	https://schemas.microsoft.com/2006/09/sip/calendarData
Schema Name	calendarData
Validation File	calendarData.xsd, calendardatatypes.xsd
Can be Empty	True