SOAP API - getCalendarEntries

The table summarizes the SOAP API - getCalendarEntries.

Request Uses the getCalendarEntries element (from the CalendarService schema)
Parameter notes
  • guid: the ID of the calendar for which information is required. The only value supported is SYSTEM.
  • start-date-time and end-date-time: start and end time filters for the information to be returned. All times are taken as UTC. This parameter is required if FREE_BUSY is specified in the required-detail filter. In other circumstances it is optional
  • required-detail: (optional): a filter to enhance the detail of the information returned. Can be:
    • WORKING_WEEK: Include working day details in the response.
    • FREE_BUSY: Include working day exceptions in the response.

      The full properties of the exception, including its GUID and free-busy value, are returned. See addWorkingDayExceptions for these properties.

Response Returns a getCalendarEntriesResponse element (from the CalendarService schema)
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cal="http://calendar.api.dac.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <cal:getCalendarEntries guid="SYSTEM" start-date-time="2011-08-01T09:00:00" end-date-time="2012-08-15T18:00:00">
         <!--Zero or more repetitions:-->
         <required-detail>FREE_BUSY</required-detail>
         <required-detail>WORKING_WEEK</required-detail>
      </cal:getCalendarEntries>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getCalendarEntriesResponse daylight-savings="true" time-zone="Europe/London" xmlns="http://calendar.api.dac.n2.tibco.com">
         <working-days day-of-week="MO" xmlns="">
            <time-slot end="13:00:00.000Z" start="09:00:00.000Z"/>
            <time-slot end="17:30:00.000Z" start="14:00:00.000Z"/>
         </working-days>
         <working-days day-of-week="TU" xmlns="">
            <time-slot end="13:00:00.000Z" start="09:00:00.000Z"/>
            <time-slot end="17:30:00.000Z" start="14:00:00.000Z"/>
         </working-days>
         <working-days day-of-week="WE" xmlns="">
            <time-slot end="13:00:00.000Z" start="09:00:00.000Z"/>
            <time-slot end="17:30:00.000Z" start="14:00:00.000Z"/>
         </working-days>
         <working-days day-of-week="TH" xmlns="">
            <time-slot end="13:00:00.000Z" start="09:00:00.000Z"/>
            <time-slot end="17:30:00.000Z" start="14:00:00.000Z"/>
         </working-days>
         <working-days day-of-week="FR" xmlns="">
            <time-slot end="13:00:00.000Z" start="09:00:00.000Z"/>
         </working-days>
         <working-days day-of-week="SA" xmlns="">
            <time-slot end="13:00:00.000Z" start="09:00:00.000Z"/>
         </working-days>
         <working-day-exceptions all-day="true" description="Public Holiday" end="2011-12-27T23:59:59.999Z" free-busy="BUSY" guid="927D8BEB-143B-48B9-8FFF-FEE1A6621D01" start="2011-12-26T00:00:00.000Z" xmlns=""/>
      </getCalendarEntriesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>