REST API - listCalendars

The table summarizes the REST API - listCalendars.

Request

Format GET <baseurl>/calendar/all
Query parameters namespace=string (optional): Returns only calendars with the given namespace.

(Note that the default base calendar SYSTEM has no namespace.)

Response

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

Example

Request
GET <baseurl>/calendar/all?namespace=LONDON
Response
 {

       "xml-fragment":

       {

           "calendar":

           [

               {

                   "@namespace": "LONDON",

                   "@name": "LONDON00",

                   "@date-created": "2012-12-20T10:28:55.493Z",

                   "@date-modified": "2012-12-20T10:28:55.510Z",

                   "@calendar-type": "BASE"

               },

               {

                   "@namespace": "LONDON",

                   "@name": "LONDON01",

                   "@date-created": "2012-12-20T10:30:09.863Z",

                   "@date-modified": "2012-12-20T10:30:09.867Z",

                   "@calendar-type": "BASE"

               },

               {

                   "@namespace": "LONDON",

                   "@name": "LONDON02",

                   "@date-created": "2012-12-20T13:28:05.277Z",

                   "@date-modified": "2012-12-20T13:28:05.283Z",

                   "@calendar-type": "BASE"

               },

               {

                   "@namespace": "LONDON",

                   "@name": "LONDON03",

                   "@date-created": "2012-12-20T13:28:10.183Z",

                   "@date-modified": "2012-12-20T13:28:10.187Z",

                   "@calendar-type": "BASE"

               }

           ]

       }

    }