GET api/Calendar/GetEvents?StartDate={StartDate}&EndDate={EndDate}
Get events from filter data. Must inclue CalendarId and CalendarRoleId header in request
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate | string |
Required |
|
| EndDate | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns an array of Event Type.
Collection of EventBaseModelView| Name | Description | Type | Additional information |
|---|---|---|---|
| HasAttachments |
HasAttachments |
boolean |
None. |
| IsAllDayEvent |
IsAllDayEvent |
boolean |
None. |
| EventId |
EventId |
string |
None. |
| Subject |
Subject |
string |
None. |
| Location |
Location |
string |
None. |
| CalendarId |
CalendarId |
string |
None. |
| CalendarName |
CalendarName |
string |
None. |
| StartDate |
StartDate |
string |
None. |
| EndDate |
EndDate |
string |
None. |
| Schedule |
Agenda |
string |
None. |
| RequiredAttendees |
RequiredAttendees |
Object |
None. |
| OptionalAttendees |
OptionalAttendees |
Object |
None. |
| HumanDate |
StartDate |
string |
None. |
| TimeZone | string |
None. |
|
| IsPrivate | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"HasAttachments": true,
"IsAllDayEvent": true,
"EventId": "sample string 3",
"Subject": "sample string 4",
"Location": "sample string 5",
"CalendarId": "sample string 6",
"CalendarName": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9",
"Schedule": "sample string 10",
"RequiredAttendees": {},
"OptionalAttendees": {},
"HumanDate": "sample string 13",
"TimeZone": "sample string 14",
"IsPrivate": true
},
{
"HasAttachments": true,
"IsAllDayEvent": true,
"EventId": "sample string 3",
"Subject": "sample string 4",
"Location": "sample string 5",
"CalendarId": "sample string 6",
"CalendarName": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9",
"Schedule": "sample string 10",
"RequiredAttendees": {},
"OptionalAttendees": {},
"HumanDate": "sample string 13",
"TimeZone": "sample string 14",
"IsPrivate": true
}
]
application/xml, text/xml
Sample:
<ArrayOfCalendarModel.EventBaseModelView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GabineteDigital.Services.Models">
<CalendarModel.EventBaseModelView>
<CalendarId>sample string 6</CalendarId>
<CalendarName>sample string 7</CalendarName>
<EndDate>sample string 9</EndDate>
<EventId>sample string 3</EventId>
<HasAttachments>true</HasAttachments>
<HumanDate>sample string 13</HumanDate>
<IsAllDayEvent>true</IsAllDayEvent>
<IsPrivate>true</IsPrivate>
<Location>sample string 5</Location>
<OptionalAttendees />
<RequiredAttendees />
<Schedule>sample string 10</Schedule>
<StartDate>sample string 8</StartDate>
<Subject>sample string 4</Subject>
<TimeZone>sample string 14</TimeZone>
</CalendarModel.EventBaseModelView>
<CalendarModel.EventBaseModelView>
<CalendarId>sample string 6</CalendarId>
<CalendarName>sample string 7</CalendarName>
<EndDate>sample string 9</EndDate>
<EventId>sample string 3</EventId>
<HasAttachments>true</HasAttachments>
<HumanDate>sample string 13</HumanDate>
<IsAllDayEvent>true</IsAllDayEvent>
<IsPrivate>true</IsPrivate>
<Location>sample string 5</Location>
<OptionalAttendees />
<RequiredAttendees />
<Schedule>sample string 10</Schedule>
<StartDate>sample string 8</StartDate>
<Subject>sample string 4</Subject>
<TimeZone>sample string 14</TimeZone>
</CalendarModel.EventBaseModelView>
</ArrayOfCalendarModel.EventBaseModelView>