POST api/CategoryEvents?startDate={startDate}&endDate={endDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

date

Required

endDate

date

Required

Body Parameters

Collection of globally unique identifier

Request Formats

application/json, text/json

Sample:
[
  "89999aa2-9b17-40e3-97ad-b02c34e0a329",
  "696b30fe-6c03-4fab-b4f7-cd9734b19c36"
]

application/xml, text/xml

Sample:
<ArrayOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <guid>89999aa2-9b17-40e3-97ad-b02c34e0a329</guid>
  <guid>696b30fe-6c03-4fab-b4f7-cd9734b19c36</guid>
</ArrayOfguid>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CategoryWithEvents
NameDescriptionTypeAdditional information
Identity

globally unique identifier

None.

Name

string

None.

Results

Collection of ResourceEvent

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Identity": "d2c3a3c6-b6fe-40e7-a399-18cd1a929f88",
    "Name": "sample string 2",
    "Results": [
      {
        "EventIdentity": "4c99296f-7648-4b97-9287-99341572e4fc",
        "StartDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "EndDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "97d74825-fc31-44c3-8c7b-f2fd8e659c5f",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "6b8e87fe-0e6f-400a-bd8d-70e18f33be40",
        "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:54:12.5803482+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": "4c99296f-7648-4b97-9287-99341572e4fc",
        "StartDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "EndDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "97d74825-fc31-44c3-8c7b-f2fd8e659c5f",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "6b8e87fe-0e6f-400a-bd8d-70e18f33be40",
        "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:54:12.5803482+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": "d2c3a3c6-b6fe-40e7-a399-18cd1a929f88",
    "Name": "sample string 2",
    "Results": [
      {
        "EventIdentity": "4c99296f-7648-4b97-9287-99341572e4fc",
        "StartDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "EndDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "97d74825-fc31-44c3-8c7b-f2fd8e659c5f",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "6b8e87fe-0e6f-400a-bd8d-70e18f33be40",
        "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:54:12.5803482+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": "4c99296f-7648-4b97-9287-99341572e4fc",
        "StartDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "EndDateTime": "2024-11-21T08:54:12.5803482+00:00",
        "UserManuallyAddedEvent": true,
        "StatusIdentity": "97d74825-fc31-44c3-8c7b-f2fd8e659c5f",
        "Status": "sample string 6",
        "StatusBackgroundColor": "sample string 7",
        "StatusTextColor": "sample string 8",
        "Identity": "6b8e87fe-0e6f-400a-bd8d-70e18f33be40",
        "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:54:12.5803482+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>d2c3a3c6-b6fe-40e7-a399-18cd1a929f88</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>6b8e87fe-0e6f-400a-bd8d-70e18f33be40</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</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:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>4c99296f-7648-4b97-9287-99341572e4fc</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>97d74825-fc31-44c3-8c7b-f2fd8e659c5f</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>6b8e87fe-0e6f-400a-bd8d-70e18f33be40</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</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:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>4c99296f-7648-4b97-9287-99341572e4fc</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>97d74825-fc31-44c3-8c7b-f2fd8e659c5f</StatusIdentity>
        <StatusTextColor>sample string 8</StatusTextColor>
        <UserManuallyAddedEvent>true</UserManuallyAddedEvent>
      </ResourceEvent>
    </Results>
  </CategoryWithEvents>
  <CategoryWithEvents>
    <Identity>d2c3a3c6-b6fe-40e7-a399-18cd1a929f88</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>6b8e87fe-0e6f-400a-bd8d-70e18f33be40</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</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:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>4c99296f-7648-4b97-9287-99341572e4fc</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>97d74825-fc31-44c3-8c7b-f2fd8e659c5f</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>6b8e87fe-0e6f-400a-bd8d-70e18f33be40</Identity>
        <IsPublished>true</IsPublished>
        <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</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:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </EndDateTime>
        <EventIdentity>4c99296f-7648-4b97-9287-99341572e4fc</EventIdentity>
        <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-21T08:54:12.5803482Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartDateTime>
        <Status>sample string 6</Status>
        <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
        <StatusIdentity>97d74825-fc31-44c3-8c7b-f2fd8e659c5f</StatusIdentity>
        <StatusTextColor>sample string 8</StatusTextColor>
        <UserManuallyAddedEvent>true</UserManuallyAddedEvent>
      </ResourceEvent>
    </Results>
  </CategoryWithEvents>
</ArrayOfCategoryWithEvents>