GET api/Admin/Calendars/{id}

Gets the calendar with the specified id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Calendar id.

 integer

Required

Body Parameters

None.

Remarks

If the calendar is not found 404 Not found are returned.
If the calendar is deleted 404 Not found are returned.

Example

Gets the calendar with id 1
GET: http://localhost/api/Admin/Calendars/1

Response Information

Resource Description

Returns the calendar with the specified id.

AdminGetCalendarResponse
NameDescriptionTypeAdditional information
Id

Calendar id.

 integer

None.
Name

Name of the calendar.

 string

None.
TimeZone

Calendar time zone.

 string

None.
Owner

Identifies the owner of the calendar.

 string

None.
CreatedBy

Created by identifier.

 string

None.
CreatedDateTime

Created date and time.

 date

None.
ChangedBy

Changed by identifier.

 string

None.
ChangedDateTime

Changed date and time.

 date

None.
CalendarProperties

List of calendar properties

 Collection of DTOCalendarProperty

None.
ScheduleIds

List of schedule ids for the calendar.

 Collection of integer

None.
ScheduledEventIds

List of Scheduled event ids for the calendar.

 Collection of integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "TimeZone": "sample string 3",
  "Owner": "sample string 4",
  "CreatedBy": "sample string 5",
  "CreatedDateTime": "2025-12-20T18:53:06.220288+00:00",
  "ChangedBy": "sample string 7",
  "ChangedDateTime": "2025-12-20T18:53:06.220288+00:00",
  "CalendarProperties": [
    {
      "Id": 1,
      "Key": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Id": 1,
      "Key": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "ScheduleIds": [
    1,
    2
  ],
  "ScheduledEventIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<AdminGetCalendarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.Calendar.Service.DTO">
  <CalendarProperties>
    <DTOCalendarProperty>
      <Id>1</Id>
      <Key>sample string 2</Key>
      <Value>sample string 3</Value>
    </DTOCalendarProperty>
    <DTOCalendarProperty>
      <Id>1</Id>
      <Key>sample string 2</Key>
      <Value>sample string 3</Value>
    </DTOCalendarProperty>
  </CalendarProperties>
  <ChangedBy>sample string 7</ChangedBy>
  <ChangedDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-20T18:53:06.220288Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ChangedDateTime>
  <CreatedBy>sample string 5</CreatedBy>
  <CreatedDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-20T18:53:06.220288Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDateTime>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Owner>sample string 4</Owner>
  <ScheduleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ScheduleIds>
  <ScheduledEventIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ScheduledEventIds>
  <TimeZone>sample string 3</TimeZone>
</AdminGetCalendarResponse>