GET api/Events?calendarId={calendarId}&queryDate={queryDate}
Gets a list of calendar events that has been changed or created after an date
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| calendarId |
Calendar Id |
integer |
Required |
| queryDate |
Get calendar events that has been changed or created after this date, valid format yyyy-MM-dd |
date |
Required |
Body Parameters
None.
Remarks
None.
Example
Gets all events for calendar with Id 3 that has been created or changed after 2016-01-01
GET: http://localhost/api/events?calendarId=3&queryDate=2016-01-01
Response Information
Resource Description
Calendar events
Collection of GetEventResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CalendarId |
Gets or sets the Calendar id |
integer |
None. |
| Id |
Gets or sets Id |
integer |
None. |
| EventReference |
Gets or sets event reference |
string |
None. |
| IsExternal |
Gets or sets whether event is external or internal |
boolean |
None. |
| CreatedDateTime |
Gets or sets created date/time |
date |
None. |
| CreatedBy |
Gets or sets who created the event |
string |
None. |
| ChangedDateTime |
Gets or sets changed date/time |
date |
None. |
| ChangedBy |
Gets or sets who last changed the event |
string |
None. |
| LatestCancellationDateTime |
Gets or sets date/time for how long it's possible to cancel event, even though it's booked If value is null, it isn't possible to cancel (?) |
date |
None. |
| EventProperties |
Gets or sets event properties |
Collection of DTOEventProperty |
None. |
| EventHistories |
Gets eventhistories |
Collection of DTOEventHistory |
None. |
| StartDateTime |
Gets or sets start date/time for event |
date |
Required |
| EndDateTime |
Gets or sets end date/time for event |
date |
Required |
| ReservationExpiresDateTime |
Gets or sets date/time for expiration of reservation |
date |
None. |
| ConfirmedDateTime |
Gets or sets date/time for when event was confirmed as booked. Value is null while not confirmed |
date |
None. |
| Note |
Gets or sets event note |
string |
Max length: 255 |
| ExternalReference |
Gets or sets the external reference for the event |
string |
Max length: 255 |
| Subject |
Gets or sets event subject |
string |
Max length: 255 |
Response Formats
application/json, text/json
[
{
"CalendarId": 1,
"Id": 1,
"EventReference": "sample string 1",
"IsExternal": true,
"CreatedDateTime": "2025-12-20T22:08:16.800808+00:00",
"CreatedBy": "sample string 2",
"ChangedDateTime": "2025-12-20T22:08:16.800808+00:00",
"ChangedBy": "sample string 3",
"LatestCancellationDateTime": "2025-12-20T22:08:16.800808+00:00",
"EventProperties": [
{
"Id": 1,
"DefaultProperty": true,
"Key": "sample string 3",
"Value": "sample string 4"
},
{
"Id": 1,
"DefaultProperty": true,
"Key": "sample string 3",
"Value": "sample string 4"
}
],
"EventHistories": [
{
"HistoryEvent": "sample string 1",
"By": "sample string 2",
"Created": "2025-12-20T22:08:16.800808+00:00"
},
{
"HistoryEvent": "sample string 1",
"By": "sample string 2",
"Created": "2025-12-20T22:08:16.800808+00:00"
}
],
"StartDateTime": "2025-12-20T22:08:16.800808+00:00",
"EndDateTime": "2025-12-20T22:08:16.800808+00:00",
"ReservationExpiresDateTime": "2025-12-20T22:08:16.800808+00:00",
"ConfirmedDateTime": "2025-12-20T22:08:16.800808+00:00",
"Note": "sample string 6",
"ExternalReference": "sample string 7",
"Subject": "sample string 8"
},
{
"CalendarId": 1,
"Id": 1,
"EventReference": "sample string 1",
"IsExternal": true,
"CreatedDateTime": "2025-12-20T22:08:16.800808+00:00",
"CreatedBy": "sample string 2",
"ChangedDateTime": "2025-12-20T22:08:16.800808+00:00",
"ChangedBy": "sample string 3",
"LatestCancellationDateTime": "2025-12-20T22:08:16.800808+00:00",
"EventProperties": [
{
"Id": 1,
"DefaultProperty": true,
"Key": "sample string 3",
"Value": "sample string 4"
},
{
"Id": 1,
"DefaultProperty": true,
"Key": "sample string 3",
"Value": "sample string 4"
}
],
"EventHistories": [
{
"HistoryEvent": "sample string 1",
"By": "sample string 2",
"Created": "2025-12-20T22:08:16.800808+00:00"
},
{
"HistoryEvent": "sample string 1",
"By": "sample string 2",
"Created": "2025-12-20T22:08:16.800808+00:00"
}
],
"StartDateTime": "2025-12-20T22:08:16.800808+00:00",
"EndDateTime": "2025-12-20T22:08:16.800808+00:00",
"ReservationExpiresDateTime": "2025-12-20T22:08:16.800808+00:00",
"ConfirmedDateTime": "2025-12-20T22:08:16.800808+00:00",
"Note": "sample string 6",
"ExternalReference": "sample string 7",
"Subject": "sample string 8"
}
]
application/xml, text/xml
<ArrayOfGetEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.Calendar.Service.DTO">
<GetEventResponse>
<ConfirmedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</ConfirmedDateTime>
<EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</EndDateTime>
<ExternalReference>sample string 7</ExternalReference>
<Note>sample string 6</Note>
<ReservationExpiresDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</ReservationExpiresDateTime>
<StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</StartDateTime>
<Subject>sample string 8</Subject>
<CalendarId>1</CalendarId>
<ChangedBy>sample string 3</ChangedBy>
<ChangedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</ChangedDateTime>
<CreatedBy>sample string 2</CreatedBy>
<CreatedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</CreatedDateTime>
<EventHistories>
<DTOEventHistory>
<By>sample string 2</By>
<Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T22:08:16.800808Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</Created>
<HistoryEvent>sample string 1</HistoryEvent>
</DTOEventHistory>
<DTOEventHistory>
<By>sample string 2</By>
<Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T22:08:16.800808Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</Created>
<HistoryEvent>sample string 1</HistoryEvent>
</DTOEventHistory>
</EventHistories>
<EventProperties>
<DTOEventProperty>
<Key>sample string 3</Key>
<Value>sample string 4</Value>
<DefaultProperty>true</DefaultProperty>
<Id>1</Id>
</DTOEventProperty>
<DTOEventProperty>
<Key>sample string 3</Key>
<Value>sample string 4</Value>
<DefaultProperty>true</DefaultProperty>
<Id>1</Id>
</DTOEventProperty>
</EventProperties>
<EventReference>sample string 1</EventReference>
<Id>1</Id>
<IsExternal>true</IsExternal>
<LatestCancellationDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</LatestCancellationDateTime>
</GetEventResponse>
<GetEventResponse>
<ConfirmedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</ConfirmedDateTime>
<EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</EndDateTime>
<ExternalReference>sample string 7</ExternalReference>
<Note>sample string 6</Note>
<ReservationExpiresDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</ReservationExpiresDateTime>
<StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</StartDateTime>
<Subject>sample string 8</Subject>
<CalendarId>1</CalendarId>
<ChangedBy>sample string 3</ChangedBy>
<ChangedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</ChangedDateTime>
<CreatedBy>sample string 2</CreatedBy>
<CreatedDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</CreatedDateTime>
<EventHistories>
<DTOEventHistory>
<By>sample string 2</By>
<Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T22:08:16.800808Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</Created>
<HistoryEvent>sample string 1</HistoryEvent>
</DTOEventHistory>
<DTOEventHistory>
<By>sample string 2</By>
<Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-20T22:08:16.800808Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</Created>
<HistoryEvent>sample string 1</HistoryEvent>
</DTOEventHistory>
</EventHistories>
<EventProperties>
<DTOEventProperty>
<Key>sample string 3</Key>
<Value>sample string 4</Value>
<DefaultProperty>true</DefaultProperty>
<Id>1</Id>
</DTOEventProperty>
<DTOEventProperty>
<Key>sample string 3</Key>
<Value>sample string 4</Value>
<DefaultProperty>true</DefaultProperty>
<Id>1</Id>
</DTOEventProperty>
</EventProperties>
<EventReference>sample string 1</EventReference>
<Id>1</Id>
<IsExternal>true</IsExternal>
<LatestCancellationDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-20T22:08:16.800808Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</LatestCancellationDateTime>
</GetEventResponse>
</ArrayOfGetEventResponse>