REST API - getCalEntries

The table summarizes the REST API - getCalEntries.

Request

Format GET <baseurl>calendar/<name>/entry/<startdate>/<enddate>
Path parameters
  • name: Name of the calendar for which exclusions are to be returned.
  • startdate, enddate: The start and end dates for the range of calendar exclusions to be retrieved.
Query parameters namespace (optional): Namespace of the calendar to be retrieved.

Response

JSON Returns a JSON representation of The content of a getCalEntriesResponse element.
XML Returns a getCalEntriesResponse element (from the WorkCalService schema).

Example

Request 
GET <baseurl>/calendar/LONDON03/entry/2012-01-01T00:00:00Z
/2016-12-31T00:00:00Z?namespace=LONDON
Response 
{
   "xml-fragment":
   {
       "@version": "1",
       "@namespace": "LONDON",
       "@name": "LONDON03",
       "@start": "2012-01-01T00:00:00Z",
       "@end": "2016-12-31T00:00:00Z",
       "recurring":
       {
           "@guid": "769B3FB9-A6F2-40FE-B39C-CEB049F266F0",
           "@description": "Monday morning mtg",
           "@start": "2010-03-19T08:30:00.000Z",
           "@all-day": "false",
           "@free-busy": "BUSY",
           "@duration": "PT1H",
           "@rrule": "FREQ=WEEKLY;BYDAY=MO",
           "occurrence":
           [
               {
                   "@start": "2012-01-02T08:30:00.000Z",
                   "@end": "2012-01-02T09:30:00.000Z"
               },
               {
                   "@start": "2012-01-09T08:30:00.000Z",
                   "@end": "2012-01-09T09:30:00.000Z"
               },
.
.
.
              {
                   "@start": "2016-12-19T08:30:00.000Z",
                   "@end": "2016-12-19T09:30:00.000Z"
               },
               {
                   "@start": "2016-12-26T08:30:00.000Z",
                   "@end": "2016-12-26T09:30:00.000Z"
               }
           ]
       }
   }
}