POST api/Resources/BusyTimes
Request Information
URI Parameters
None.
Body Parameters
ResourcesCalendarOptionsName | Description | 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": [ "050d0385-b089-4e3e-96c2-d8dbecb0ce15", "561b0860-bfcf-487e-80a3-7d7679fe802b" ], "ConcurrencyGroupIdentities": [ "b4caece9-16c9-4324-995e-24623859cb56", "e1b628ed-d968-4a54-8b9b-81fd826869e6" ], "ResourceIdentities": [ "9de3effd-5920-4d88-8c7c-0d6c92d0343b", "bf73e90f-7edb-4602-8ee1-54a615efc372" ], "IncludeTemplateAvailability": true, "IncludeConcurrencyGroups": true, "IncludeLinkedAvailabilityPatterns": true, "IncludeEnabledLinkedAvailabilityPatternsOnly": true, "StartDate": "2025-09-05T18:55:35.1288347+00:00", "EndDate": "2025-09-05T18:55:35.1288347+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>050d0385-b089-4e3e-96c2-d8dbecb0ce15</d2p1:guid> <d2p1:guid>561b0860-bfcf-487e-80a3-7d7679fe802b</d2p1:guid> </ConcurrencyConfigurationIdentities> <ConcurrencyGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>b4caece9-16c9-4324-995e-24623859cb56</d2p1:guid> <d2p1:guid>e1b628ed-d968-4a54-8b9b-81fd826869e6</d2p1:guid> </ConcurrencyGroupIdentities> <EndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-09-05T18:55:35.1288347Z</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>9de3effd-5920-4d88-8c7c-0d6c92d0343b</d2p1:guid> <d2p1:guid>bf73e90f-7edb-4602-8ee1-54a615efc372</d2p1:guid> </ResourceIdentities> <StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-09-05T18:55:35.1288347Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </StartDate> </ResourcesCalendarOptions>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of FreeBlocksForMultipleResourcesName | Description | 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": [ "a793b22d-66dd-4ab9-83f7-ffbef2fd138a", "c6af002c-3a4c-4af7-9219-ea401ab58772" ], "Identity": "cb7b66ba-7065-44c1-8f5d-ae9eafe000a7", "EventIdentity": "ef6d4195-ed69-4e9b-98e3-feefb005bf15", "StartDateTime": "2025-09-05T18:55:35.1288347+00:00", "Duration": 4.1, "AvailabilityType": 5, "Name": "sample string 6", "ConcurrencyResourceName": "sample string 7", "Repeats": true, "EntityIdentity": "10269a9d-f41d-4649-872d-6fbea52fa57b" }, { "ResourceIdentities": [ "a793b22d-66dd-4ab9-83f7-ffbef2fd138a", "c6af002c-3a4c-4af7-9219-ea401ab58772" ], "Identity": "cb7b66ba-7065-44c1-8f5d-ae9eafe000a7", "EventIdentity": "ef6d4195-ed69-4e9b-98e3-feefb005bf15", "StartDateTime": "2025-09-05T18:55:35.1288347+00:00", "Duration": 4.1, "AvailabilityType": 5, "Name": "sample string 6", "ConcurrencyResourceName": "sample string 7", "Repeats": true, "EntityIdentity": "10269a9d-f41d-4649-872d-6fbea52fa57b" } ]
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>10269a9d-f41d-4649-872d-6fbea52fa57b</EntityIdentity> <EventIdentity>ef6d4195-ed69-4e9b-98e3-feefb005bf15</EventIdentity> <Identity>cb7b66ba-7065-44c1-8f5d-ae9eafe000a7</Identity> <Name>sample string 6</Name> <Repeats>true</Repeats> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-09-05T18:55:35.1288347Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> <ResourceIdentities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>a793b22d-66dd-4ab9-83f7-ffbef2fd138a</d3p1:guid> <d3p1:guid>c6af002c-3a4c-4af7-9219-ea401ab58772</d3p1:guid> </ResourceIdentities> </FreeBlocksForMultipleResources> <FreeBlocksForMultipleResources> <AvailabilityType>5</AvailabilityType> <ConcurrencyResourceName>sample string 7</ConcurrencyResourceName> <Duration>4.1</Duration> <EntityIdentity>10269a9d-f41d-4649-872d-6fbea52fa57b</EntityIdentity> <EventIdentity>ef6d4195-ed69-4e9b-98e3-feefb005bf15</EventIdentity> <Identity>cb7b66ba-7065-44c1-8f5d-ae9eafe000a7</Identity> <Name>sample string 6</Name> <Repeats>true</Repeats> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-09-05T18:55:35.1288347Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> <ResourceIdentities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>a793b22d-66dd-4ab9-83f7-ffbef2fd138a</d3p1:guid> <d3p1:guid>c6af002c-3a4c-4af7-9219-ea401ab58772</d3p1:guid> </ResourceIdentities> </FreeBlocksForMultipleResources> </ArrayOfFreeBlocksForMultipleResources>