REST API - getCalendar

The table summarizes the REST API - getCalendar.

Request

Format GET <baseurl>/calendar/<name>
Path parameters name: Name of the calendar to be listed.
Query parameters namespace=string (optional): The combination of namespace and name uniquely identifies a calendar. Note that the default SYSTEM calendar has no namespace.

Response

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

Example

Request 
GET <baseurl>/calendar/LONDON01?namespace=LONDON
Response 
{
  "base-calendar": {
    "@version": "0",
    "@namespace": "LONDON",
    "@name": "LONDON01",
    "@date-created": "2012-12-20T10:30:09.863Z",
    "@date-modified": "2012-12-20T10:30:09.867Z",
    "@calendar-type": "BASE",
    "@time-zone": "GMT",
    "@min-hours": "4",
    "working-days": [
      {
        "@day-of-week": "MO",
        "time-slot": [
          {
            "@start": "08:00:00.000Z",
            "@end": "12:00:00.000Z"
          },
          {
            "@start": "13:00:00.000Z",
            "@end": "18:00:00.000Z"
          }
        ]
      },
.
.
.
      {
        "@day-of-week": "FR",
        "time-slot": [
          {
            "@start": "08:00:00.000Z",
            "@end": "12:00:00.000Z"
          },
          {
            "@start": "13:00:00.000Z",
            "@end": "16:00:00.000Z"
          }
        ]
      }
    ]
  }
}