GET api/ResourceTypes/{resourceTypeIdentity}/Resources/{resourceIdentity}/BusyPatterns?rangeStartDate={rangeStartDate}&rangeEndDate={rangeEndDate}&includeLinkedAvailability={includeLinkedAvailability}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
resourceTypeIdentity | string |
Required |
|
resourceIdentity | string |
Required |
|
rangeStartDate | date |
Required |
|
rangeEndDate | date |
Required |
|
includeLinkedAvailability | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of BusyPatternName | Description | Type | Additional information |
---|---|---|---|
UniqueIdentity | globally unique identifier |
None. |
|
StartDateTime | date |
None. |
|
EndDateTime | date |
None. |
|
Duration | decimal number |
None. |
|
Days | Collection of DayOfWeek |
None. |
|
Repeat | boolean |
None. |
|
IsException | boolean |
None. |
|
DstDifference | time interval |
None. |
|
DayOffset | integer |
None. |
|
Identity | globally unique identifier |
None. |
|
AvailabilityType | AvailabilityType |
None. |
|
EntityType | AvailabilityEntityType |
None. |
|
OffsetAtCreation | time interval |
None. |
|
RepeatStartLocal | time interval |
None. |
|
RepeatEndLocal | time interval |
None. |
|
Name | string |
None. |
|
IsLinkedPattern | boolean |
None. |
|
LinkedEntities | Collection of globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "UniqueIdentity": "82b3c759-0b6e-4ff4-b884-b1f90181c5c0", "StartDateTime": "2025-09-14T10:28:43.8987119+00:00", "EndDateTime": "2025-09-14T10:28:43.8987119+00:00", "Duration": 4.1, "Days": [ 0, 0 ], "Repeat": true, "IsException": true, "DstDifference": "00:00:00.1234567", "DayOffset": 8, "Identity": "03817fba-bd5e-4d74-8e15-6ade75723f3a", "AvailabilityType": 0, "EntityType": 0, "OffsetAtCreation": "00:00:00.1234567", "RepeatStartLocal": "00:00:00.1234567", "RepeatEndLocal": "00:00:00.1234567", "Name": "sample string 13", "IsLinkedPattern": true, "LinkedEntities": [ "02f5a9f2-ce8b-4dab-8155-47cdf1b55ecc", "69dbc552-80c9-4581-b737-4e4baf707c28" ] }, { "UniqueIdentity": "82b3c759-0b6e-4ff4-b884-b1f90181c5c0", "StartDateTime": "2025-09-14T10:28:43.8987119+00:00", "EndDateTime": "2025-09-14T10:28:43.8987119+00:00", "Duration": 4.1, "Days": [ 0, 0 ], "Repeat": true, "IsException": true, "DstDifference": "00:00:00.1234567", "DayOffset": 8, "Identity": "03817fba-bd5e-4d74-8e15-6ade75723f3a", "AvailabilityType": 0, "EntityType": 0, "OffsetAtCreation": "00:00:00.1234567", "RepeatStartLocal": "00:00:00.1234567", "RepeatEndLocal": "00:00:00.1234567", "Name": "sample string 13", "IsLinkedPattern": true, "LinkedEntities": [ "02f5a9f2-ce8b-4dab-8155-47cdf1b55ecc", "69dbc552-80c9-4581-b737-4e4baf707c28" ] } ]
application/xml, text/xml
Sample:
<ArrayOfBusyPattern xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <BusyPattern> <AvailabilityType>Specific</AvailabilityType> <DayOffset>8</DayOffset> <Days xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DayOfWeek>Sunday</d3p1:DayOfWeek> <d3p1:DayOfWeek>Sunday</d3p1:DayOfWeek> </Days> <DstDifference>PT0.1234567S</DstDifference> <Duration>4.1</Duration> <EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-09-14T10:28:43.8987119Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </EndDateTime> <EntityType>Resource</EntityType> <Identity>03817fba-bd5e-4d74-8e15-6ade75723f3a</Identity> <IsException>true</IsException> <IsLinkedPattern>true</IsLinkedPattern> <LinkedEntities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>02f5a9f2-ce8b-4dab-8155-47cdf1b55ecc</d3p1:guid> <d3p1:guid>69dbc552-80c9-4581-b737-4e4baf707c28</d3p1:guid> </LinkedEntities> <Name>sample string 13</Name> <OffsetAtCreation>PT0.1234567S</OffsetAtCreation> <Repeat>true</Repeat> <RepeatEndLocal>PT0.1234567S</RepeatEndLocal> <RepeatStartLocal>PT0.1234567S</RepeatStartLocal> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-09-14T10:28:43.8987119Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> <UniqueIdentity>82b3c759-0b6e-4ff4-b884-b1f90181c5c0</UniqueIdentity> </BusyPattern> <BusyPattern> <AvailabilityType>Specific</AvailabilityType> <DayOffset>8</DayOffset> <Days xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DayOfWeek>Sunday</d3p1:DayOfWeek> <d3p1:DayOfWeek>Sunday</d3p1:DayOfWeek> </Days> <DstDifference>PT0.1234567S</DstDifference> <Duration>4.1</Duration> <EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-09-14T10:28:43.8987119Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </EndDateTime> <EntityType>Resource</EntityType> <Identity>03817fba-bd5e-4d74-8e15-6ade75723f3a</Identity> <IsException>true</IsException> <IsLinkedPattern>true</IsLinkedPattern> <LinkedEntities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>02f5a9f2-ce8b-4dab-8155-47cdf1b55ecc</d3p1:guid> <d3p1:guid>69dbc552-80c9-4581-b737-4e4baf707c28</d3p1:guid> </LinkedEntities> <Name>sample string 13</Name> <OffsetAtCreation>PT0.1234567S</OffsetAtCreation> <Repeat>true</Repeat> <RepeatEndLocal>PT0.1234567S</RepeatEndLocal> <RepeatStartLocal>PT0.1234567S</RepeatStartLocal> <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2025-09-14T10:28:43.8987119Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartDateTime> <UniqueIdentity>82b3c759-0b6e-4ff4-b884-b1f90181c5c0</UniqueIdentity> </BusyPattern> </ArrayOfBusyPattern>