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": [ "2fc6ec28-c18f-4ced-ba8d-a16cbb5ce2bc", "84543137-ba08-48a0-a1d1-66b0a7d900e1" ], "ConcurrencyGroupIdentities": [ "16bc5993-257c-4972-aa5f-1c7967accb3b", "ccbeac5d-c73b-470e-9d06-7b8f4d63961e" ], "ResourceIdentities": [ "edc10d10-4f68-4a50-ad3d-27c726070d53", "ca5b605c-804d-4dce-8f7c-522a76d3f439" ], "IncludeTemplateAvailability": true, "IncludeConcurrencyGroups": true, "IncludeLinkedAvailabilityPatterns": true, "IncludeEnabledLinkedAvailabilityPatternsOnly": true, "StartDate": "2025-08-31T10:11:50.5623613+00:00", "EndDate": "2025-08-31T10:11:50.5623613+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>2fc6ec28-c18f-4ced-ba8d-a16cbb5ce2bc</d2p1:guid> <d2p1:guid>84543137-ba08-48a0-a1d1-66b0a7d900e1</d2p1:guid> </ConcurrencyConfigurationIdentities> <ConcurrencyGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>16bc5993-257c-4972-aa5f-1c7967accb3b</d2p1:guid> <d2p1:guid>ccbeac5d-c73b-470e-9d06-7b8f4d63961e</d2p1:guid> </ConcurrencyGroupIdentities> <EndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-08-31T10:11:50.5623613Z</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>edc10d10-4f68-4a50-ad3d-27c726070d53</d2p1:guid> <d2p1:guid>ca5b605c-804d-4dce-8f7c-522a76d3f439</d2p1:guid> </ResourceIdentities> <StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-08-31T10:11:50.5623613Z</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": [ "37e2a831-efae-4f85-b352-288a823caa59", "53f0db5a-082a-49a9-9396-803ea798ff9c" ], "Identity": "447b17d6-c62a-4707-98f0-e23301d7ebe0", "EventIdentity": "ff198876-02e2-4e49-ad39-d38c17a5b1a6", "StartDateTime": "2025-08-31T10:11:50.5623613+00:00", "Duration": 4.1, "AvailabilityType": 5, "Name": "sample string 6", "ConcurrencyResourceName": "sample string 7", "Repeats": true, "EntityIdentity": "6d9674d8-4497-4378-90b1-6c5c2af2f608" }, { "ResourceIdentities": [ "37e2a831-efae-4f85-b352-288a823caa59", "53f0db5a-082a-49a9-9396-803ea798ff9c" ], "Identity": "447b17d6-c62a-4707-98f0-e23301d7ebe0", "EventIdentity": "ff198876-02e2-4e49-ad39-d38c17a5b1a6", "StartDateTime": "2025-08-31T10:11:50.5623613+00:00", "Duration": 4.1, "AvailabilityType": 5, "Name": "sample string 6", "ConcurrencyResourceName": "sample string 7", "Repeats": true, "EntityIdentity": "6d9674d8-4497-4378-90b1-6c5c2af2f608" } ]
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>6d9674d8-4497-4378-90b1-6c5c2af2f608</EntityIdentity> <EventIdentity>ff198876-02e2-4e49-ad39-d38c17a5b1a6</EventIdentity> <Identity>447b17d6-c62a-4707-98f0-e23301d7ebe0</Identity> <Name>sample string 6</Name> <Repeats>true</Repeats> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-08-31T10:11:50.5623613Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> <ResourceIdentities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>37e2a831-efae-4f85-b352-288a823caa59</d3p1:guid> <d3p1:guid>53f0db5a-082a-49a9-9396-803ea798ff9c</d3p1:guid> </ResourceIdentities> </FreeBlocksForMultipleResources> <FreeBlocksForMultipleResources> <AvailabilityType>5</AvailabilityType> <ConcurrencyResourceName>sample string 7</ConcurrencyResourceName> <Duration>4.1</Duration> <EntityIdentity>6d9674d8-4497-4378-90b1-6c5c2af2f608</EntityIdentity> <EventIdentity>ff198876-02e2-4e49-ad39-d38c17a5b1a6</EventIdentity> <Identity>447b17d6-c62a-4707-98f0-e23301d7ebe0</Identity> <Name>sample string 6</Name> <Repeats>true</Repeats> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-08-31T10:11:50.5623613Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> <ResourceIdentities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>37e2a831-efae-4f85-b352-288a823caa59</d3p1:guid> <d3p1:guid>53f0db5a-082a-49a9-9396-803ea798ff9c</d3p1:guid> </ResourceIdentities> </FreeBlocksForMultipleResources> </ArrayOfFreeBlocksForMultipleResources>