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	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": [
    "d43df5f9-1c74-4fa1-848a-7d5fa1d68345",
    "26399cde-97b8-48a8-b97b-e3f5a335dfeb"
  ],
  "PermissionGroupIdentities": [
    "d4b8fe56-ad7e-4383-ace0-ec74037ab4e0",
    "dfd41809-fd0e-4021-9313-9c408bc97e65"
  ],
  "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>d43df5f9-1c74-4fa1-848a-7d5fa1d68345</d2p1:guid>
    <d2p1:guid>26399cde-97b8-48a8-b97b-e3f5a335dfeb</d2p1:guid>
  </CategoryIdentities>
  <IncludeBookings>true</IncludeBookings>
  <PermissionGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>d4b8fe56-ad7e-4383-ace0-ec74037ab4e0</d2p1:guid>
    <d2p1:guid>dfd41809-fd0e-4021-9313-9c408bc97e65</d2p1:guid>
  </PermissionGroupIdentities>
  <UsePermissionGroupStatusCache>true</UsePermissionGroupStatusCache>
</CategoryEventSearchFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CategoryWithEvents

Name	Type	Additional information
Identity	globally unique identifier	None.
Name	string	None.
Results	Collection of ResourceEvent	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Identity": "d92f7dd3-bf04-4b52-b57a-6f0efcbb74de",
    "Name": "sample string 2",
    "Results": [
      {
        "EventIdentity": "2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff",
        "StartDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "EndDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "9da80359-e18a-415a-a2f3-ea47ef15f37c",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "4b60340e-74c7-4efd-9749-70955a99ee3b",
        "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": "2024-11-21T08:38:51.0949149+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": "2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff",
        "StartDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "EndDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "9da80359-e18a-415a-a2f3-ea47ef15f37c",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "4b60340e-74c7-4efd-9749-70955a99ee3b",
        "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": "2024-11-21T08:38:51.0949149+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": "d92f7dd3-bf04-4b52-b57a-6f0efcbb74de",
    "Name": "sample string 2",
    "Results": [
      {
        "EventIdentity": "2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff",
        "StartDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "EndDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "9da80359-e18a-415a-a2f3-ea47ef15f37c",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "4b60340e-74c7-4efd-9749-70955a99ee3b",
        "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": "2024-11-21T08:38:51.0949149+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": "2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff",
        "StartDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "EndDateTime": "2024-11-21T08:38:51.0949149+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "9da80359-e18a-415a-a2f3-ea47ef15f37c",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "4b60340e-74c7-4efd-9749-70955a99ee3b",
        "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": "2024-11-21T08:38:51.0949149+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>d92f7dd3-bf04-4b52-b57a-6f0efcbb74de</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>4b60340e-74c7-4efd-9749-70955a99ee3b</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</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>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>9da80359-e18a-415a-a2f3-ea47ef15f37c</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>4b60340e-74c7-4efd-9749-70955a99ee3b</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</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>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>9da80359-e18a-415a-a2f3-ea47ef15f37c</StatusIdentity>
        <StatusTextColor>sample string 8</StatusTextColor>
        <UserManuallyAddedEvent>true</UserManuallyAddedEvent>
      </ResourceEvent>
    </Results>
  </CategoryWithEvents>
  <CategoryWithEvents>
    <Identity>d92f7dd3-bf04-4b52-b57a-6f0efcbb74de</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>4b60340e-74c7-4efd-9749-70955a99ee3b</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</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>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>9da80359-e18a-415a-a2f3-ea47ef15f37c</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>4b60340e-74c7-4efd-9749-70955a99ee3b</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</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>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>2b3e62c3-ec54-4369-ab42-4ce2dc9f27ff</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:38:51.0949149Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>9da80359-e18a-415a-a2f3-ea47ef15f37c</StatusIdentity>
        <StatusTextColor>sample string 8</StatusTextColor>
        <UserManuallyAddedEvent>true</UserManuallyAddedEvent>
      </ResourceEvent>
    </Results>
  </CategoryWithEvents>
</ArrayOfCategoryWithEvents>