POST api/CategoryEvents/filter?startDate={startDate}&endDate={endDate}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| startDate | date |
Required |
|
| endDate | date |
Required |
Body Parameters
CategoryEventSearchFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| CategoryIdentities | Collection of globally unique identifier |
None. |
|
| PermissionGroupIdentities | Collection of globally unique identifier |
None. |
|
| UsePermissionGroupStatusCache | boolean |
None. |
|
| IncludeBookings | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"CategoryIdentities": [
"fae9b9d0-02e7-458a-8d52-7ada1623d5a8",
"d15a1924-ea08-4917-bc56-64fc208756f8"
],
"PermissionGroupIdentities": [
"e2e5ae9b-408b-420e-b764-7155e95cb3d1",
"1e5e6632-9a16-4be1-a4f8-97c262b0e638"
],
"UsePermissionGroupStatusCache": true,
"IncludeBookings": true
}
application/xml, text/xml
Sample:
<CategoryEventSearchFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
<CategoryIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>fae9b9d0-02e7-458a-8d52-7ada1623d5a8</d2p1:guid>
<d2p1:guid>d15a1924-ea08-4917-bc56-64fc208756f8</d2p1:guid>
</CategoryIdentities>
<IncludeBookings>true</IncludeBookings>
<PermissionGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>e2e5ae9b-408b-420e-b764-7155e95cb3d1</d2p1:guid>
<d2p1:guid>1e5e6632-9a16-4be1-a4f8-97c262b0e638</d2p1:guid>
</PermissionGroupIdentities>
<UsePermissionGroupStatusCache>true</UsePermissionGroupStatusCache>
</CategoryEventSearchFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of CategoryWithEvents| Name | Description | Type | Additional information |
|---|---|---|---|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Results | Collection of ResourceEvent |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Identity": "ec25c825-0459-4731-9f53-dfecadbb93f1",
"Name": "sample string 2",
"Results": [
{
"EventIdentity": "ec54d4ae-d6ef-4995-8d4b-1f6e1370c753",
"StartDateTime": "2026-10-30T03:42:21.4115261+00:00",
"EndDateTime": "2026-10-30T03:42:21.4115261+00:00",
"UserManuallyAddedEvent": true,
"StatusIdentity": "d4564e92-4002-4393-9ab5-a82233b014f8",
"Status": "sample string 6",
"StatusBackgroundColor": "sample string 7",
"StatusTextColor": "sample string 8",
"Identity": "f8828245-03d4-41a8-8f84-27c8d8875704",
"Location": "sample string 10",
"Description": "sample string 11",
"HostKey": "sample string 12",
"Name": "sample string 13",
"EventType": "sample string 14",
"Owner": "sample string 15",
"IsPublished": true,
"LastModified": "2026-10-30T03:42:21.4115261+00:00",
"ParentKey": "sample string 18",
"ExtraProperties": [
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
},
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
}
],
"StatusName": "sample string 19",
"Source": "sample string 20",
"WeekRanges": "sample string 21",
"WeekLabels": "sample string 22"
},
{
"EventIdentity": "ec54d4ae-d6ef-4995-8d4b-1f6e1370c753",
"StartDateTime": "2026-10-30T03:42:21.4115261+00:00",
"EndDateTime": "2026-10-30T03:42:21.4115261+00:00",
"UserManuallyAddedEvent": true,
"StatusIdentity": "d4564e92-4002-4393-9ab5-a82233b014f8",
"Status": "sample string 6",
"StatusBackgroundColor": "sample string 7",
"StatusTextColor": "sample string 8",
"Identity": "f8828245-03d4-41a8-8f84-27c8d8875704",
"Location": "sample string 10",
"Description": "sample string 11",
"HostKey": "sample string 12",
"Name": "sample string 13",
"EventType": "sample string 14",
"Owner": "sample string 15",
"IsPublished": true,
"LastModified": "2026-10-30T03:42:21.4115261+00:00",
"ParentKey": "sample string 18",
"ExtraProperties": [
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
},
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
}
],
"StatusName": "sample string 19",
"Source": "sample string 20",
"WeekRanges": "sample string 21",
"WeekLabels": "sample string 22"
}
]
},
{
"Identity": "ec25c825-0459-4731-9f53-dfecadbb93f1",
"Name": "sample string 2",
"Results": [
{
"EventIdentity": "ec54d4ae-d6ef-4995-8d4b-1f6e1370c753",
"StartDateTime": "2026-10-30T03:42:21.4115261+00:00",
"EndDateTime": "2026-10-30T03:42:21.4115261+00:00",
"UserManuallyAddedEvent": true,
"StatusIdentity": "d4564e92-4002-4393-9ab5-a82233b014f8",
"Status": "sample string 6",
"StatusBackgroundColor": "sample string 7",
"StatusTextColor": "sample string 8",
"Identity": "f8828245-03d4-41a8-8f84-27c8d8875704",
"Location": "sample string 10",
"Description": "sample string 11",
"HostKey": "sample string 12",
"Name": "sample string 13",
"EventType": "sample string 14",
"Owner": "sample string 15",
"IsPublished": true,
"LastModified": "2026-10-30T03:42:21.4115261+00:00",
"ParentKey": "sample string 18",
"ExtraProperties": [
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
},
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
}
],
"StatusName": "sample string 19",
"Source": "sample string 20",
"WeekRanges": "sample string 21",
"WeekLabels": "sample string 22"
},
{
"EventIdentity": "ec54d4ae-d6ef-4995-8d4b-1f6e1370c753",
"StartDateTime": "2026-10-30T03:42:21.4115261+00:00",
"EndDateTime": "2026-10-30T03:42:21.4115261+00:00",
"UserManuallyAddedEvent": true,
"StatusIdentity": "d4564e92-4002-4393-9ab5-a82233b014f8",
"Status": "sample string 6",
"StatusBackgroundColor": "sample string 7",
"StatusTextColor": "sample string 8",
"Identity": "f8828245-03d4-41a8-8f84-27c8d8875704",
"Location": "sample string 10",
"Description": "sample string 11",
"HostKey": "sample string 12",
"Name": "sample string 13",
"EventType": "sample string 14",
"Owner": "sample string 15",
"IsPublished": true,
"LastModified": "2026-10-30T03:42:21.4115261+00:00",
"ParentKey": "sample string 18",
"ExtraProperties": [
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
},
{
"Name": "sample string 1",
"DisplayName": "sample string 2",
"Value": "sample string 3",
"Rank": 4
}
],
"StatusName": "sample string 19",
"Source": "sample string 20",
"WeekRanges": "sample string 21",
"WeekLabels": "sample string 22"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfCategoryWithEvents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
<CategoryWithEvents>
<Identity>ec25c825-0459-4731-9f53-dfecadbb93f1</Identity>
<Name>sample string 2</Name>
<Results>
<ResourceEvent>
<WeekLabels>sample string 22</WeekLabels>
<WeekRanges>sample string 21</WeekRanges>
<Description>sample string 11</Description>
<EventType>sample string 14</EventType>
<ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
</ExtraProperties>
<HostKey>sample string 12</HostKey>
<Identity>f8828245-03d4-41a8-8f84-27c8d8875704</Identity>
<IsPublished>true</IsPublished>
<LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</LastModified>
<Location>sample string 10</Location>
<Name>sample string 13</Name>
<Owner>sample string 15</Owner>
<ParentKey>sample string 18</ParentKey>
<Source>sample string 20</Source>
<StatusName>sample string 19</StatusName>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<EventIdentity>ec54d4ae-d6ef-4995-8d4b-1f6e1370c753</EventIdentity>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
<Status>sample string 6</Status>
<StatusBackgroundColor>sample string 7</StatusBackgroundColor>
<StatusIdentity>d4564e92-4002-4393-9ab5-a82233b014f8</StatusIdentity>
<StatusTextColor>sample string 8</StatusTextColor>
<UserManuallyAddedEvent>true</UserManuallyAddedEvent>
</ResourceEvent>
<ResourceEvent>
<WeekLabels>sample string 22</WeekLabels>
<WeekRanges>sample string 21</WeekRanges>
<Description>sample string 11</Description>
<EventType>sample string 14</EventType>
<ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
</ExtraProperties>
<HostKey>sample string 12</HostKey>
<Identity>f8828245-03d4-41a8-8f84-27c8d8875704</Identity>
<IsPublished>true</IsPublished>
<LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</LastModified>
<Location>sample string 10</Location>
<Name>sample string 13</Name>
<Owner>sample string 15</Owner>
<ParentKey>sample string 18</ParentKey>
<Source>sample string 20</Source>
<StatusName>sample string 19</StatusName>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<EventIdentity>ec54d4ae-d6ef-4995-8d4b-1f6e1370c753</EventIdentity>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
<Status>sample string 6</Status>
<StatusBackgroundColor>sample string 7</StatusBackgroundColor>
<StatusIdentity>d4564e92-4002-4393-9ab5-a82233b014f8</StatusIdentity>
<StatusTextColor>sample string 8</StatusTextColor>
<UserManuallyAddedEvent>true</UserManuallyAddedEvent>
</ResourceEvent>
</Results>
</CategoryWithEvents>
<CategoryWithEvents>
<Identity>ec25c825-0459-4731-9f53-dfecadbb93f1</Identity>
<Name>sample string 2</Name>
<Results>
<ResourceEvent>
<WeekLabels>sample string 22</WeekLabels>
<WeekRanges>sample string 21</WeekRanges>
<Description>sample string 11</Description>
<EventType>sample string 14</EventType>
<ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
</ExtraProperties>
<HostKey>sample string 12</HostKey>
<Identity>f8828245-03d4-41a8-8f84-27c8d8875704</Identity>
<IsPublished>true</IsPublished>
<LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</LastModified>
<Location>sample string 10</Location>
<Name>sample string 13</Name>
<Owner>sample string 15</Owner>
<ParentKey>sample string 18</ParentKey>
<Source>sample string 20</Source>
<StatusName>sample string 19</StatusName>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<EventIdentity>ec54d4ae-d6ef-4995-8d4b-1f6e1370c753</EventIdentity>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
<Status>sample string 6</Status>
<StatusBackgroundColor>sample string 7</StatusBackgroundColor>
<StatusIdentity>d4564e92-4002-4393-9ab5-a82233b014f8</StatusIdentity>
<StatusTextColor>sample string 8</StatusTextColor>
<UserManuallyAddedEvent>true</UserManuallyAddedEvent>
</ResourceEvent>
<ResourceEvent>
<WeekLabels>sample string 22</WeekLabels>
<WeekRanges>sample string 21</WeekRanges>
<Description>sample string 11</Description>
<EventType>sample string 14</EventType>
<ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
<d5p1:ExtraProperty>
<d5p1:DisplayName>sample string 2</d5p1:DisplayName>
<d5p1:Name>sample string 1</d5p1:Name>
<d5p1:Rank>4</d5p1:Rank>
<d5p1:Value>sample string 3</d5p1:Value>
</d5p1:ExtraProperty>
</ExtraProperties>
<HostKey>sample string 12</HostKey>
<Identity>f8828245-03d4-41a8-8f84-27c8d8875704</Identity>
<IsPublished>true</IsPublished>
<LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</LastModified>
<Location>sample string 10</Location>
<Name>sample string 13</Name>
<Owner>sample string 15</Owner>
<ParentKey>sample string 18</ParentKey>
<Source>sample string 20</Source>
<StatusName>sample string 19</StatusName>
<EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</EndDateTime>
<EventIdentity>ec54d4ae-d6ef-4995-8d4b-1f6e1370c753</EventIdentity>
<StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-10-30T03:42:21.4115261Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</StartDateTime>
<Status>sample string 6</Status>
<StatusBackgroundColor>sample string 7</StatusBackgroundColor>
<StatusIdentity>d4564e92-4002-4393-9ab5-a82233b014f8</StatusIdentity>
<StatusTextColor>sample string 8</StatusTextColor>
<UserManuallyAddedEvent>true</UserManuallyAddedEvent>
</ResourceEvent>
</Results>
</CategoryWithEvents>
</ArrayOfCategoryWithEvents>