GET api/Calendars/{id}?dateFrom={dateFrom}&dateTo={dateTo}
Gets a calendar by id and between specified dates.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Calendar Id |
integer |
Required |
| dateFrom |
Get calendar with events from date, valid format yyyy-MM-dd |
date |
Required |
| dateTo |
Get calendar with events to date, valid format yyyy-MM-dd |
date |
Required |
Body Parameters
None.
Remarks
None.
Example
Gets calendar
GET: http://localhost/api/calendar/1
Response Information
Resource Description
Returns a calendar.
GetCalendarByIdAndDateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Calendar id. |
integer |
None. |
| Name |
Calendar name. |
string |
None. |
| TimeZoneId |
Time zone name |
string |
None. |
| CalendarProperties |
List of calendar properties |
Collection of DTOCalendarProperty |
None. |
| Days |
List of calendar day information. |
Collection of CalendarDayInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"Name": "sample string 2",
"TimeZoneId": "sample string 3",
"CalendarProperties": [
{
"Id": 1,
"Key": "sample string 2",
"Value": "sample string 3"
},
{
"Id": 1,
"Key": "sample string 2",
"Value": "sample string 3"
}
],
"Days": [
{
"Date": "2025-12-20",
"TimeZoneOffset": "00:00",
"DaySchedules": [
{
"StartTime": "00:00",
"EndTime": "00:00",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartTime": "00:00",
"EndTime": "00:00",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"OpenScheduledEvents": [
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"ClosedScheduledEvents": [
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"CurrentOccupancyRate": 3.0,
"OccupancyRate": 1.0
},
{
"Date": "2025-12-20",
"TimeZoneOffset": "00:00",
"DaySchedules": [
{
"StartTime": "00:00",
"EndTime": "00:00",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartTime": "00:00",
"EndTime": "00:00",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"OpenScheduledEvents": [
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"ClosedScheduledEvents": [
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartTime": "00:00",
"EndTime": "00:00",
"Note": "sample string 3",
"DefaultProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"CurrentOccupancyRate": 3.0,
"OccupancyRate": 1.0
}
]
}
application/xml, text/xml
Sample:
<GetCalendarByIdAndDateResponse 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>
<Days>
<CalendarDayInfo>
<ClosedScheduledEvents>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
</ClosedScheduledEvents>
<CurrentOccupancyRate>3</CurrentOccupancyRate>
<Date>2025-12-20T18:53:05.6265212+00:00</Date>
<DaySchedules>
<DayScheduleInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<StartTime>PT0.1234567S</StartTime>
</DayScheduleInfo>
<DayScheduleInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<StartTime>PT0.1234567S</StartTime>
</DayScheduleInfo>
</DaySchedules>
<OccupancyRate>1</OccupancyRate>
<OpenScheduledEvents>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
</OpenScheduledEvents>
<TimeZoneOffset>PT0.1234567S</TimeZoneOffset>
</CalendarDayInfo>
<CalendarDayInfo>
<ClosedScheduledEvents>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
</ClosedScheduledEvents>
<CurrentOccupancyRate>3</CurrentOccupancyRate>
<Date>2025-12-20T18:53:05.6265212+00:00</Date>
<DaySchedules>
<DayScheduleInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<StartTime>PT0.1234567S</StartTime>
</DayScheduleInfo>
<DayScheduleInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<StartTime>PT0.1234567S</StartTime>
</DayScheduleInfo>
</DaySchedules>
<OccupancyRate>1</OccupancyRate>
<OpenScheduledEvents>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
<ScheduledEventInfo>
<DefaultProperties>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
<DefaultPropertiesData>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</DefaultPropertiesData>
</DefaultProperties>
<EndTime>PT0.1234567S</EndTime>
<Note>sample string 3</Note>
<StartTime>PT0.1234567S</StartTime>
</ScheduledEventInfo>
</OpenScheduledEvents>
<TimeZoneOffset>PT0.1234567S</TimeZoneOffset>
</CalendarDayInfo>
</Days>
<Id>1</Id>
<Name>sample string 2</Name>
<TimeZoneId>sample string 3</TimeZoneId>
</GetCalendarByIdAndDateResponse>