POST api/Calendar/Preview

Request Information

URI Parameters

None.

Body Parameters

Collection of globally unique identifier

Request Formats

application/json, text/json

Sample:

[
  "afa01a00-6015-45fa-8e92-f1e23b6db4e2",
  "30968c3d-00d0-4e34-88c7-53c9ca8eb62d"
]

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>afa01a00-6015-45fa-8e92-f1e23b6db4e2</guid>
  <guid>30968c3d-00d0-4e34-88c7-53c9ca8eb62d</guid>
</ArrayOfguid>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResourceWithEvents

Name	Description	Type	Additional information
Identity		globally unique identifier	None.
ResourceEvents		Collection of ResourceEvent	None.

Response Formats

application/json, text/json

Sample:

{
  "Identity": "f2d237ee-0722-4371-a753-dfdade7dd418",
  "ResourceEvents": [
    {
      "EventIdentity": "87e9e735-fb82-49d6-8cf4-1dee29c3208f",
      "StartDateTime": "2025-11-02T00:58:15.9721286+00:00",
      "EndDateTime": "2025-11-02T00:58:15.9721286+00:00",
      "UserManuallyAddedEvent": true,
      "StatusIdentity": "41a6898a-3e59-4c08-95e4-54f0ffd55a8f",
      "Status": "sample string 6",
      "StatusBackgroundColor": "sample string 7",
      "StatusTextColor": "sample string 8",
      "Identity": "cbf8e97b-3141-4fb1-84f0-05afee494cbc",
      "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": "2025-11-02T00:58:15.9721286+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": "87e9e735-fb82-49d6-8cf4-1dee29c3208f",
      "StartDateTime": "2025-11-02T00:58:15.9721286+00:00",
      "EndDateTime": "2025-11-02T00:58:15.9721286+00:00",
      "UserManuallyAddedEvent": true,
      "StatusIdentity": "41a6898a-3e59-4c08-95e4-54f0ffd55a8f",
      "Status": "sample string 6",
      "StatusBackgroundColor": "sample string 7",
      "StatusTextColor": "sample string 8",
      "Identity": "cbf8e97b-3141-4fb1-84f0-05afee494cbc",
      "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": "2025-11-02T00:58:15.9721286+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:

<ResourceWithEvents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
  <Identity>f2d237ee-0722-4371-a753-dfdade7dd418</Identity>
  <ResourceEvents xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
    <d2p1:ResourceEvent>
      <d2p1:WeekLabels>sample string 22</d2p1:WeekLabels>
      <d2p1:WeekRanges>sample string 21</d2p1:WeekRanges>
      <d2p1:Description>sample string 11</d2p1:Description>
      <d2p1:EventType>sample string 14</d2p1:EventType>
      <d2p1:ExtraProperties xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
        <d4p1:ExtraProperty>
          <d4p1:DisplayName>sample string 2</d4p1:DisplayName>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Rank>4</d4p1:Rank>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:ExtraProperty>
        <d4p1:ExtraProperty>
          <d4p1:DisplayName>sample string 2</d4p1:DisplayName>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Rank>4</d4p1:Rank>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:ExtraProperty>
      </d2p1:ExtraProperties>
      <d2p1:HostKey>sample string 12</d2p1:HostKey>
      <d2p1:Identity>cbf8e97b-3141-4fb1-84f0-05afee494cbc</d2p1:Identity>
      <d2p1:IsPublished>true</d2p1:IsPublished>
      <d2p1:LastModified xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-11-02T00:58:15.9721286Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:LastModified>
      <d2p1:Location>sample string 10</d2p1:Location>
      <d2p1:Name>sample string 13</d2p1:Name>
      <d2p1:Owner>sample string 15</d2p1:Owner>
      <d2p1:ParentKey>sample string 18</d2p1:ParentKey>
      <d2p1:Source>sample string 20</d2p1:Source>
      <d2p1:StatusName>sample string 19</d2p1:StatusName>
      <d2p1:EndDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-11-02T00:58:15.9721286Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:EndDateTime>
      <d2p1:EventIdentity>87e9e735-fb82-49d6-8cf4-1dee29c3208f</d2p1:EventIdentity>
      <d2p1:StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-11-02T00:58:15.9721286Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:StartDateTime>
      <d2p1:Status>sample string 6</d2p1:Status>
      <d2p1:StatusBackgroundColor>sample string 7</d2p1:StatusBackgroundColor>
      <d2p1:StatusIdentity>41a6898a-3e59-4c08-95e4-54f0ffd55a8f</d2p1:StatusIdentity>
      <d2p1:StatusTextColor>sample string 8</d2p1:StatusTextColor>
      <d2p1:UserManuallyAddedEvent>true</d2p1:UserManuallyAddedEvent>
    </d2p1:ResourceEvent>
    <d2p1:ResourceEvent>
      <d2p1:WeekLabels>sample string 22</d2p1:WeekLabels>
      <d2p1:WeekRanges>sample string 21</d2p1:WeekRanges>
      <d2p1:Description>sample string 11</d2p1:Description>
      <d2p1:EventType>sample string 14</d2p1:EventType>
      <d2p1:ExtraProperties xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
        <d4p1:ExtraProperty>
          <d4p1:DisplayName>sample string 2</d4p1:DisplayName>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Rank>4</d4p1:Rank>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:ExtraProperty>
        <d4p1:ExtraProperty>
          <d4p1:DisplayName>sample string 2</d4p1:DisplayName>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Rank>4</d4p1:Rank>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:ExtraProperty>
      </d2p1:ExtraProperties>
      <d2p1:HostKey>sample string 12</d2p1:HostKey>
      <d2p1:Identity>cbf8e97b-3141-4fb1-84f0-05afee494cbc</d2p1:Identity>
      <d2p1:IsPublished>true</d2p1:IsPublished>
      <d2p1:LastModified xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-11-02T00:58:15.9721286Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:LastModified>
      <d2p1:Location>sample string 10</d2p1:Location>
      <d2p1:Name>sample string 13</d2p1:Name>
      <d2p1:Owner>sample string 15</d2p1:Owner>
      <d2p1:ParentKey>sample string 18</d2p1:ParentKey>
      <d2p1:Source>sample string 20</d2p1:Source>
      <d2p1:StatusName>sample string 19</d2p1:StatusName>
      <d2p1:EndDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-11-02T00:58:15.9721286Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:EndDateTime>
      <d2p1:EventIdentity>87e9e735-fb82-49d6-8cf4-1dee29c3208f</d2p1:EventIdentity>
      <d2p1:StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-11-02T00:58:15.9721286Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:StartDateTime>
      <d2p1:Status>sample string 6</d2p1:Status>
      <d2p1:StatusBackgroundColor>sample string 7</d2p1:StatusBackgroundColor>
      <d2p1:StatusIdentity>41a6898a-3e59-4c08-95e4-54f0ffd55a8f</d2p1:StatusIdentity>
      <d2p1:StatusTextColor>sample string 8</d2p1:StatusTextColor>
      <d2p1:UserManuallyAddedEvent>true</d2p1:UserManuallyAddedEvent>
    </d2p1:ResourceEvent>
  </ResourceEvents>
</ResourceWithEvents>