POST api/Resources/BusyTimes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ResourceFilterType	ResourceFilterType	None.
ConcurrencyConfigurationIdentities	Collection of globally unique identifier	None.
ConcurrencyGroupIdentities	Collection of globally unique identifier	None.
ResourceIdentities	Collection of globally unique identifier	None.
IncludeTemplateAvailability	boolean	None.
IncludeConcurrencyGroups	boolean	None.
IncludeLinkedAvailabilityPatterns	boolean	None.
IncludeEnabledLinkedAvailabilityPatternsOnly	boolean	None.
StartDate	date	None.
EndDate	date	None.
IncludeExamEvents	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ResourceFilterType": 0,
  "ConcurrencyConfigurationIdentities": [
    "44e245e4-e64f-4840-ab59-67002fe72137",
    "0178dca1-32fe-46f4-bf59-324ae0f7fd6a"
  ],
  "ConcurrencyGroupIdentities": [
    "135a22e7-4f3d-47a4-bed3-1c071975b9f7",
    "1310a54a-3195-45f3-af8d-aabc850d823a"
  ],
  "ResourceIdentities": [
    "9140f88f-ca80-443c-8502-5eeabbf65e72",
    "c2066d10-6502-47dd-8415-6f0600cb5891"
  ],
  "IncludeTemplateAvailability": true,
  "IncludeConcurrencyGroups": true,
  "IncludeLinkedAvailabilityPatterns": true,
  "IncludeEnabledLinkedAvailabilityPatternsOnly": true,
  "StartDate": "2024-11-21T08:36:38.7214758+00:00",
  "EndDate": "2024-11-21T08:36:38.7214758+00:00",
  "IncludeExamEvents": true
}

application/xml, text/xml

Sample:

<ResourcesCalendarOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <ConcurrencyConfigurationIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>44e245e4-e64f-4840-ab59-67002fe72137</d2p1:guid>
    <d2p1:guid>0178dca1-32fe-46f4-bf59-324ae0f7fd6a</d2p1:guid>
  </ConcurrencyConfigurationIdentities>
  <ConcurrencyGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>135a22e7-4f3d-47a4-bed3-1c071975b9f7</d2p1:guid>
    <d2p1:guid>1310a54a-3195-45f3-af8d-aabc850d823a</d2p1:guid>
  </ConcurrencyGroupIdentities>
  <EndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-21T08:36:38.7214758Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </EndDate>
  <IncludeConcurrencyGroups>true</IncludeConcurrencyGroups>
  <IncludeEnabledLinkedAvailabilityPatternsOnly>true</IncludeEnabledLinkedAvailabilityPatternsOnly>
  <IncludeExamEvents>true</IncludeExamEvents>
  <IncludeLinkedAvailabilityPatterns>true</IncludeLinkedAvailabilityPatterns>
  <IncludeTemplateAvailability>true</IncludeTemplateAvailability>
  <ResourceFilterType>ConcurrencyConfiguration</ResourceFilterType>
  <ResourceIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>9140f88f-ca80-443c-8502-5eeabbf65e72</d2p1:guid>
    <d2p1:guid>c2066d10-6502-47dd-8415-6f0600cb5891</d2p1:guid>
  </ResourceIdentities>
  <StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-21T08:36:38.7214758Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </StartDate>
</ResourcesCalendarOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of FreeBlocksForMultipleResources

Name	Type	Additional information
ResourceIdentities	Collection of globally unique identifier	None.
Identity	globally unique identifier	None.
EventIdentity	globally unique identifier	None.
StartDateTime	date	None.
Duration	decimal number	None.
AvailabilityType	integer	None.
Name	string	None.
ConcurrencyResourceName	string	None.
Repeats	boolean	None.
EntityIdentity	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ResourceIdentities": [
      "855119cf-84d0-4905-a037-4b67fd011972",
      "65cc9805-f373-48bb-a08d-bc2a5cab0f9e"
    ],
    "Identity": "3a93297b-d797-4e7d-8dd4-e93aced60267",
    "EventIdentity": "d05d9e3b-755b-4612-b03b-e4533b3e4672",
    "StartDateTime": "2024-11-21T08:36:38.7214758+00:00",
    "Duration": 4.1,
    "AvailabilityType": 5,
    "Name": "sample string 6",
    "ConcurrencyResourceName": "sample string 7",
    "Repeats": true,
    "EntityIdentity": "99cad40d-ffcf-468a-9d77-eba4a677f4f1"
  },
  {
    "ResourceIdentities": [
      "855119cf-84d0-4905-a037-4b67fd011972",
      "65cc9805-f373-48bb-a08d-bc2a5cab0f9e"
    ],
    "Identity": "3a93297b-d797-4e7d-8dd4-e93aced60267",
    "EventIdentity": "d05d9e3b-755b-4612-b03b-e4533b3e4672",
    "StartDateTime": "2024-11-21T08:36:38.7214758+00:00",
    "Duration": 4.1,
    "AvailabilityType": 5,
    "Name": "sample string 6",
    "ConcurrencyResourceName": "sample string 7",
    "Repeats": true,
    "EntityIdentity": "99cad40d-ffcf-468a-9d77-eba4a677f4f1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfFreeBlocksForMultipleResources xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <FreeBlocksForMultipleResources>
    <AvailabilityType>5</AvailabilityType>
    <ConcurrencyResourceName>sample string 7</ConcurrencyResourceName>
    <Duration>4.1</Duration>
    <EntityIdentity>99cad40d-ffcf-468a-9d77-eba4a677f4f1</EntityIdentity>
    <EventIdentity>d05d9e3b-755b-4612-b03b-e4533b3e4672</EventIdentity>
    <Identity>3a93297b-d797-4e7d-8dd4-e93aced60267</Identity>
    <Name>sample string 6</Name>
    <Repeats>true</Repeats>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T08:36:38.7214758Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <ResourceIdentities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>855119cf-84d0-4905-a037-4b67fd011972</d3p1:guid>
      <d3p1:guid>65cc9805-f373-48bb-a08d-bc2a5cab0f9e</d3p1:guid>
    </ResourceIdentities>
  </FreeBlocksForMultipleResources>
  <FreeBlocksForMultipleResources>
    <AvailabilityType>5</AvailabilityType>
    <ConcurrencyResourceName>sample string 7</ConcurrencyResourceName>
    <Duration>4.1</Duration>
    <EntityIdentity>99cad40d-ffcf-468a-9d77-eba4a677f4f1</EntityIdentity>
    <EventIdentity>d05d9e3b-755b-4612-b03b-e4533b3e4672</EventIdentity>
    <Identity>3a93297b-d797-4e7d-8dd4-e93aced60267</Identity>
    <Name>sample string 6</Name>
    <Repeats>true</Repeats>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T08:36:38.7214758Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <ResourceIdentities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>855119cf-84d0-4905-a037-4b67fd011972</d3p1:guid>
      <d3p1:guid>65cc9805-f373-48bb-a08d-bc2a5cab0f9e</d3p1:guid>
    </ResourceIdentities>
  </FreeBlocksForMultipleResources>
</ArrayOfFreeBlocksForMultipleResources>