GET api/BookingTypes/{bookingTypeIdentity}/Resources/{resourceIdentity}/BusyTimes?startDate={startDate}&endDate={endDate}&excludeExamEvents={excludeExamEvents}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bookingTypeIdentity | string |
Required |
|
resourceIdentity | string |
Required |
|
startDate | date |
Required |
|
endDate | date |
Required |
|
excludeExamEvents | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of FreeBlocksName | Description | Type | Additional information |
---|---|---|---|
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:
[ { "Identity": "d60b436b-03a0-47e0-bcbd-f93e2cd8822f", "EventIdentity": "62b24ccf-4017-43a6-9cff-ba41fe42017b", "StartDateTime": "2025-04-03T23:03:51.2883553+00:00", "Duration": 4.1, "AvailabilityType": 5, "Name": "sample string 6", "ConcurrencyResourceName": "sample string 7", "Repeats": true, "EntityIdentity": "ccb87d6a-65bf-43af-9391-cb902736df61" }, { "Identity": "d60b436b-03a0-47e0-bcbd-f93e2cd8822f", "EventIdentity": "62b24ccf-4017-43a6-9cff-ba41fe42017b", "StartDateTime": "2025-04-03T23:03:51.2883553+00:00", "Duration": 4.1, "AvailabilityType": 5, "Name": "sample string 6", "ConcurrencyResourceName": "sample string 7", "Repeats": true, "EntityIdentity": "ccb87d6a-65bf-43af-9391-cb902736df61" } ]
application/xml, text/xml
Sample:
<ArrayOfFreeBlocks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <FreeBlocks> <AvailabilityType>5</AvailabilityType> <ConcurrencyResourceName>sample string 7</ConcurrencyResourceName> <Duration>4.1</Duration> <EntityIdentity>ccb87d6a-65bf-43af-9391-cb902736df61</EntityIdentity> <EventIdentity>62b24ccf-4017-43a6-9cff-ba41fe42017b</EventIdentity> <Identity>d60b436b-03a0-47e0-bcbd-f93e2cd8822f</Identity> <Name>sample string 6</Name> <Repeats>true</Repeats> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-04-03T23:03:51.2883553Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> </FreeBlocks> <FreeBlocks> <AvailabilityType>5</AvailabilityType> <ConcurrencyResourceName>sample string 7</ConcurrencyResourceName> <Duration>4.1</Duration> <EntityIdentity>ccb87d6a-65bf-43af-9391-cb902736df61</EntityIdentity> <EventIdentity>62b24ccf-4017-43a6-9cff-ba41fe42017b</EventIdentity> <Identity>d60b436b-03a0-47e0-bcbd-f93e2cd8822f</Identity> <Name>sample string 6</Name> <Repeats>true</Repeats> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-04-03T23:03:51.2883553Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> </FreeBlocks> </ArrayOfFreeBlocks>