element <getCalendarDaysRequest> (global)
Namespace:
http://schemas.microsoft.com/hs/2001/10/myCalendar
Type:
anonymous complexType (extension of domainStandardMethodParametersType)
Content:
complex, 4 elements
Defined:
globally in myCalendar.xsd; see XML source
Includes:
definition of 1 element
Used:
never
XML Representation Summary
<getCalendarDaysRequest>
   
Content: 
</getCalendarDaysRequest>
Content model elements (4):
calendarType (type calendarLocaleEnum), endTime (type xsd:dateTime), removeRecurrence (in getCalendarDaysRequest), startTime (type xsd:dateTime)
Annotation
This function returns an XML stream of calendar appointments / events between two dates. Recurrence rules are expanded to create individual calendar items. Holidays are represented as all-day events, and these are returned as well. getCalendarDays is a query-retrieval of data, but the behavior expands recurrence rules into individual (aliased) events, adds in holidays, and adds regular events and sorts the entire list based on start time. No merging of event blocks occurs. Any object which overlaps the method parameters {startTime, endTime} will be returned. For example, if an event crosses midnight and the startTime is 12am, that event will be returned. In case the startDate, endDate is one day, the events are sorted in the following order: holidays, all-day events, and regular events (based on startTime). <br/>The {startTime, endTime] time window can define any interval: 24hr period, week, month, or any other user-defined period. <br/><b>getCalendarDays</b> returns the calendaring info of any puid that is specified for which the caller has sufficient privileges. The user's own puid must be specified to retrieve their own information. <br/><b>getCalendarDays</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="getCalendarDaysRequest">
<xsd:annotation>
<xsd:documentation>
This function returns an XML stream of calendar appointments /
events between two dates. Recurrence rules are expanded to create
individual calendar items. Holidays are represented as all-day
events, and these are returned as well. getCalendarDays is a
query-retrieval of data, but the behavior expands recurrence rules
into individual (aliased) events, adds in holidays, and adds regular
events and sorts the entire list based on start time. No merging of
event blocks occurs. Any object which overlaps the method parameters
{startTime, endTime} will be returned. For example, if an event crosses
midnight and the startTime is 12am, that event will be returned. In
case the startDate, endDate is one day, the events are
sorted in the following order: holidays, all-day events, and regular
events (based on startTime).
<br/>
The {startTime, endTime] time window can define any
interval: 24hr period, week, month, or any other user-defined
period.
<br/>
<b>getCalendarDays</b>
returns the calendaring info of
any puid that is specified for which the caller has sufficient
privileges. The user's own puid must be specified to retrieve their own
information.
<br/>
<b>getCalendarDays</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="removeRecurrence" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Normally, the recurrence sub-schema, (minus modifiedException and minus
deletedExceptionDate components) is returned with each instance of a
recurring event, like "recurring-instance" and "recurring-exception". This
allows clients to properly render the recurrence pattern without having
to explicitly query the recurring-master. However, because it is heavy
on bandwith, .NET Calendar includes the option to not return this data.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
Content Element Detail (all declarations; 4/4)
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>
removeRecurrence
Type:
xsd:boolean, predefined, simple content
Defined:
locally within (this) getCalendarDaysRequest element
Normally, the recurrence sub-schema, (minus modifiedException and minus deletedExceptionDate components) is returned with each instance of a recurring event, like "recurring-instance" and "recurring-exception". This allows clients to properly render the recurrence pattern without having to explicitly query the recurring-master. However, because it is heavy on bandwith, .NET Calendar includes the option to not return this data.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="removeRecurrence" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Normally, the recurrence sub-schema, (minus modifiedException and minus
deletedExceptionDate components) is returned with each instance of a
recurring event, like "recurring-instance" and "recurring-exception". This
allows clients to properly render the recurrence pattern without having
to explicitly query the recurring-master. However, because it is heavy
on bandwith, .NET Calendar includes the option to not return this data.
</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>