POST api/Calendars/TimeSlot
Gets a list of available time slots.
Request Information
URI Parameters
None.
Body Parameters
GetAvailableTimeSlotsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CalendarId |
Calendar Id. |
integer |
Required |
| FromDate |
Start date and time. |
date |
None. |
| ToDate |
End date and time. |
date |
None. |
| EventLength |
Length of time slots, in minutes. |
time interval |
None. |
| ExternalOccupancyRateFactor |
If this is set then it overrides calendar schedules occupancyrate |
decimal number |
None. |
Remarks
None.
Example
None.
Request Formats
application/json, text/json
Sample:
{
"CalendarId": 1,
"FromDate": "2025-12-20",
"ToDate": "2025-12-20",
"EventLength": "00:00",
"ExternalOccupancyRateFactor": 1.0
}
application/xml, text/xml
Sample:
<GetAvailableTimeSlotsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.Calendar.Service.DTO"> <CalendarId>1</CalendarId> <EventLength>PT0.1234567S</EventLength> <ExternalOccupancyRateFactor>1</ExternalOccupancyRateFactor> <FromDate>2025-12-20T18:53:05.0598463+00:00</FromDate> <ToDate>2025-12-20T18:53:05.0598463+00:00</ToDate> </GetAvailableTimeSlotsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns available time slots.
Collection of GetAvailableTimeSlotsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AvailableTimeSlots |
List of available time slots |
Collection of CalendarAvailableTimeSlotView |
None. |
| OpenSlotsWithProperties | Collection of AvailableTimeSlotWithProperties |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"AvailableTimeSlots": [
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00"
},
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00"
}
],
"OpenSlotsWithProperties": [
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00",
"Properties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00",
"Properties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
]
},
{
"AvailableTimeSlots": [
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00"
},
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00"
}
],
"OpenSlotsWithProperties": [
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00",
"Properties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"StartDateTime": "2025-12-20T18:53:05.0598463+00:00",
"EndDateTime": "2025-12-20T18:53:05.0598463+00:00",
"Properties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfGetAvailableTimeSlotsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.Calendar.Service.DTO">
<GetAvailableTimeSlotsResponse>
<AvailableTimeSlots>
<CalendarAvailableTimeSlotView>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</CalendarAvailableTimeSlotView>
<CalendarAvailableTimeSlotView>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</CalendarAvailableTimeSlotView>
</AvailableTimeSlots>
<OpenSlotsWithProperties>
<AvailableTimeSlotWithProperties>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<Properties xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
</Properties>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</AvailableTimeSlotWithProperties>
<AvailableTimeSlotWithProperties>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<Properties xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
</Properties>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</AvailableTimeSlotWithProperties>
</OpenSlotsWithProperties>
</GetAvailableTimeSlotsResponse>
<GetAvailableTimeSlotsResponse>
<AvailableTimeSlots>
<CalendarAvailableTimeSlotView>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</CalendarAvailableTimeSlotView>
<CalendarAvailableTimeSlotView>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</CalendarAvailableTimeSlotView>
</AvailableTimeSlots>
<OpenSlotsWithProperties>
<AvailableTimeSlotWithProperties>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<Properties xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
</Properties>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</AvailableTimeSlotWithProperties>
<AvailableTimeSlotWithProperties>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<Properties xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
<d5p1:KeyValuePairOfstringstring>
<d5p1:key>sample string 1</d5p1:key>
<d5p1:value>sample string 2</d5p1:value>
</d5p1:KeyValuePairOfstringstring>
</Properties>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T18:53:05.0598463Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
</AvailableTimeSlotWithProperties>
</OpenSlotsWithProperties>
</GetAvailableTimeSlotsResponse>
</ArrayOfGetAvailableTimeSlotsResponse>