GET api/Calendars

Gets a list of all calendars specified by keys in the http header API-CalendarKeys.

Request Information

URI Parameters

None.

Body Parameters

None.

Remarks

None.

Example

Gets all calendars
GET: http://localhost/api/calendars

Response Information

Resource Description

Returns all calendars.

Collection of GetCalendarResponse
NameDescriptionTypeAdditional information
CalendarId

Calendar id.

 integer

None.
CalendarKey

Calendar key.

 string

None.
Name

Name of the calendar.

 string

None.
MaxAuthorizationLevel

Max authorization level for the calendar based on the key.

 string

None.
LastChangedDateTime

Date and time when the calendar or schedule was last changed.

 date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CalendarId": 1,
    "CalendarKey": "sample string 2",
    "Name": "sample string 3",
    "MaxAuthorizationLevel": "sample string 4",
    "LastChangedDateTime": "2025-12-20T22:05:30.7733614+00:00"
  },
  {
    "CalendarId": 1,
    "CalendarKey": "sample string 2",
    "Name": "sample string 3",
    "MaxAuthorizationLevel": "sample string 4",
    "LastChangedDateTime": "2025-12-20T22:05:30.7733614+00:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfGetCalendarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.Calendar.Service.DTO">
  <GetCalendarResponse>
    <CalendarId>1</CalendarId>
    <CalendarKey>sample string 2</CalendarKey>
    <LastChangedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-20T22:05:30.7733614Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </LastChangedDateTime>
    <MaxAuthorizationLevel>sample string 4</MaxAuthorizationLevel>
    <Name>sample string 3</Name>
  </GetCalendarResponse>
  <GetCalendarResponse>
    <CalendarId>1</CalendarId>
    <CalendarKey>sample string 2</CalendarKey>
    <LastChangedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-20T22:05:30.7733614Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </LastChangedDateTime>
    <MaxAuthorizationLevel>sample string 4</MaxAuthorizationLevel>
    <Name>sample string 3</Name>
  </GetCalendarResponse>
</ArrayOfGetCalendarResponse>