REST API - saveCalendarEntry Create a Recurring Exclusion

The table summarizes the REST API - saveCalendarEntry: Create a Recurring Exclusion.

Request

Format POST <baseurl>/calendar/<name>/<version>/entry/<description>/<startdate>/
<duration>/<rrule>/<responsestartdate>/<responseenddate>
Path parameters
  • name: Name of the calendar to which the exclusion is being added.
  • version: Version number of the calendar; used to detect concurrent updates to the same calendar.
  • description: a description of the new exclusion.
  • duration: The length of each occurrence of a recurring exclusion. Defined as in RFC-5545.
  • rrule: The recurrence rule. This is the expression used to define a recurring calendar exclusion. The format of the rule is defined as in RFC-5545. See Adding Recurring Exclusions for more information on recurring exclusions.
  • startdate: The date and time when the new calendar exclusion starts.
  • responsestartdate, responseenddate: Start and end date-times within which exclusions should be included in the response.
Query parameters
  • namespace=string (optional): The combination of namespace and name uniquely identifies a calendar. Note that the default SYSTEM calendar has no namespace.
  • allday=boolean (optional): Whether the exclusion lasts the whole day. Defaults to false.
  • freebusy=enumeration (optional): Whether this exclusion denotes available working time (FREE) or unavailable working time (BUSY). Defaults to BUSY.

Response

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

Example

Request 
POST <baseurl>/calendar/LONDON01/0/entry/New Year/
2013-01-01T00:00:00Z/P1D/FREQ=YEARLY/2013-12-01T00:00:00Z/2015-01-31T00:00:00Z?namespace=LONDON
Response 
{
  "xml-fragment": {
    "@version": "1",
    "@namespace": "LONDON",
    "@name": "LONDON01",
    "@start": "2013-12-01T00:00:00Z",
    "@end": "2015-01-31T00:00:00Z",
    "recurring": {
      "@guid": "7B77A42A-5CD2-4514-A115-9A81A6128568",
      "@description": "New Year",
      "@start": "2013-01-01T00:00:00.000Z",
      "@all-day": "false",
      "@free-busy": "BUSY",
      "@duration": "P1D",
      "@rrule": "FREQ=YEARLY",
      "occurrence": [
        {
          "@start": "2014-01-01T00:00:00.000Z",
          "@end": "2014-01-02T00:00:00.000Z"
        },
        {
          "@start": "2015-01-01T00:00:00.000Z",
          "@end": "2015-01-02T00:00:00.000Z"
        }
      ]
    }
  }
}