POST api/ReviewCalendar

Request Information

URI Parameters

None.

Body Parameters

ResourceEventFilter
NameDescriptionTypeAdditional information
PermissionGroupIdentities

Collection of globally unique identifier

None.

BypassActivityManager

boolean

None.

UserManuallyAddedEventsOnly

boolean

None.

IsIcalFeed

boolean

None.

ResourceIdentities

Collection of globally unique identifier

None.

RangeStart

date

None.

RangeEnd

date

None.

Request Formats

application/json, text/json

Sample:
{
  "PermissionGroupIdentities": [
    "27ff4936-158a-43ce-bd50-ec98d8a6e505",
    "4f3f9ac6-f03f-4b3c-9669-d184a3eb30f1"
  ],
  "BypassActivityManager": true,
  "UserManuallyAddedEventsOnly": true,
  "IsIcalFeed": true,
  "ResourceIdentities": [
    "589221cf-1f31-4ab2-a577-2150055d9ad2",
    "d920402f-24bc-4eff-80fd-6935ed4c5ad3"
  ],
  "RangeStart": "2024-11-21T09:17:41.715066+00:00",
  "RangeEnd": "2024-11-21T09:17:41.715066+00:00"
}

application/xml, text/xml

Sample:
<ResourceEventFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <RangeEnd>2024-11-21T09:17:41.715066+00:00</RangeEnd>
  <RangeStart>2024-11-21T09:17:41.715066+00:00</RangeStart>
  <ResourceIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>589221cf-1f31-4ab2-a577-2150055d9ad2</d2p1:guid>
    <d2p1:guid>d920402f-24bc-4eff-80fd-6935ed4c5ad3</d2p1:guid>
  </ResourceIdentities>
  <BypassActivityManager>true</BypassActivityManager>
  <IsIcalFeed>true</IsIcalFeed>
  <PermissionGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>27ff4936-158a-43ce-bd50-ec98d8a6e505</d2p1:guid>
    <d2p1:guid>4f3f9ac6-f03f-4b3c-9669-d184a3eb30f1</d2p1:guid>
  </PermissionGroupIdentities>
  <UserManuallyAddedEventsOnly>true</UserManuallyAddedEventsOnly>
</ResourceEventFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ResourceEvent
NameDescriptionTypeAdditional information
EventIdentity

globally unique identifier

None.

StartDateTime

date

None.

EndDateTime

date

None.

UserManuallyAddedEvent

boolean

None.

StatusIdentity

globally unique identifier

None.

Status

string

None.

StatusBackgroundColor

string

None.

StatusTextColor

string

None.

Identity

globally unique identifier

None.

Location

string

None.

Description

string

None.

HostKey

string

None.

Name

string

None.

EventType

string

None.

Owner

string

None.

IsPublished

boolean

None.

LastModified

date

None.

ParentKey

string

None.

ExtraProperties

Collection of ExtraProperty

None.

StatusName

string

None.

Source

string

None.

WeekRanges

string

None.

WeekLabels

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EventIdentity": "84c25d3c-7e34-4017-b16d-d6c5cf99b4ee",
    "StartDateTime": "2024-11-21T09:17:41.715066+00:00",
    "EndDateTime": "2024-11-21T09:17:41.715066+00:00",
    "UserManuallyAddedEvent": true,
    "StatusIdentity": "9a73456e-911c-4e72-acdf-55a0ad14c0dc",
    "Status": "sample string 6",
    "StatusBackgroundColor": "sample string 7",
    "StatusTextColor": "sample string 8",
    "Identity": "870ebfe1-ca9f-4c37-8fca-25b0a790f8fc",
    "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-21T09:17:41.715066+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": "84c25d3c-7e34-4017-b16d-d6c5cf99b4ee",
    "StartDateTime": "2024-11-21T09:17:41.715066+00:00",
    "EndDateTime": "2024-11-21T09:17:41.715066+00:00",
    "UserManuallyAddedEvent": true,
    "StatusIdentity": "9a73456e-911c-4e72-acdf-55a0ad14c0dc",
    "Status": "sample string 6",
    "StatusBackgroundColor": "sample string 7",
    "StatusTextColor": "sample string 8",
    "Identity": "870ebfe1-ca9f-4c37-8fca-25b0a790f8fc",
    "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-21T09:17:41.715066+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:
<ArrayOfResourceEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <ResourceEvent>
    <WeekLabels>sample string 22</WeekLabels>
    <WeekRanges>sample string 21</WeekRanges>
    <Description>sample string 11</Description>
    <EventType>sample string 14</EventType>
    <ExtraProperties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
      <d3p1:ExtraProperty>
        <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Rank>4</d3p1:Rank>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:ExtraProperty>
      <d3p1:ExtraProperty>
        <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Rank>4</d3p1:Rank>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:ExtraProperty>
    </ExtraProperties>
    <HostKey>sample string 12</HostKey>
    <Identity>870ebfe1-ca9f-4c37-8fca-25b0a790f8fc</Identity>
    <IsPublished>true</IsPublished>
    <LastModified xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:17:41.715066Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:17:41.715066Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDateTime>
    <EventIdentity>84c25d3c-7e34-4017-b16d-d6c5cf99b4ee</EventIdentity>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:17:41.715066Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <Status>sample string 6</Status>
    <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
    <StatusIdentity>9a73456e-911c-4e72-acdf-55a0ad14c0dc</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:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
      <d3p1:ExtraProperty>
        <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Rank>4</d3p1:Rank>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:ExtraProperty>
      <d3p1:ExtraProperty>
        <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Rank>4</d3p1:Rank>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:ExtraProperty>
    </ExtraProperties>
    <HostKey>sample string 12</HostKey>
    <Identity>870ebfe1-ca9f-4c37-8fca-25b0a790f8fc</Identity>
    <IsPublished>true</IsPublished>
    <LastModified xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:17:41.715066Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:17:41.715066Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDateTime>
    <EventIdentity>84c25d3c-7e34-4017-b16d-d6c5cf99b4ee</EventIdentity>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:17:41.715066Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <Status>sample string 6</Status>
    <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
    <StatusIdentity>9a73456e-911c-4e72-acdf-55a0ad14c0dc</StatusIdentity>
    <StatusTextColor>sample string 8</StatusTextColor>
    <UserManuallyAddedEvent>true</UserManuallyAddedEvent>
  </ResourceEvent>
</ArrayOfResourceEvent>