GET api/AvailabilityPatterns/{availabilityConfigIdentity}/PreviewUnavailability?rangeStartDate={rangeStartDate}&rangeEndDate={rangeEndDate}&includeAvailabilitySpecific={includeAvailabilitySpecific}&includeAvailabilityRepeating={includeAvailabilityRepeating}

Request Information

URI Parameters

Name	Type	Additional information
availabilityConfigIdentity	string	Required
rangeStartDate	date	Required
rangeEndDate	date	Required
includeAvailabilitySpecific	boolean	Default value is True
includeAvailabilityRepeating	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of BusyPattern

Name	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": "37e14be3-ec8f-421f-a1a5-cc1924d5ce79",
    "StartDateTime": "2025-01-29T03:05:18.4641177+00:00",
    "EndDateTime": "2025-01-29T03:05:18.4641177+00:00",
    "Duration": 4.1,
    "Days": [
      0,
      0
    ],
    "Repeat": true,
    "IsException": true,
    "DstDifference": "00:00:00.1234567",
    "DayOffset": 8,
    "Identity": "67402097-ab19-4080-b7dd-ca2896024806",
    "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": [
      "01da6c1a-3a1f-412e-a5a0-6d41b06c6986",
      "3e6d3238-9c51-4f11-99b1-d33ac18e9d88"
    ]
  },
  {
    "UniqueIdentity": "37e14be3-ec8f-421f-a1a5-cc1924d5ce79",
    "StartDateTime": "2025-01-29T03:05:18.4641177+00:00",
    "EndDateTime": "2025-01-29T03:05:18.4641177+00:00",
    "Duration": 4.1,
    "Days": [
      0,
      0
    ],
    "Repeat": true,
    "IsException": true,
    "DstDifference": "00:00:00.1234567",
    "DayOffset": 8,
    "Identity": "67402097-ab19-4080-b7dd-ca2896024806",
    "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": [
      "01da6c1a-3a1f-412e-a5a0-6d41b06c6986",
      "3e6d3238-9c51-4f11-99b1-d33ac18e9d88"
    ]
  }
]

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-01-29T03:05:18.4641177Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDateTime>
    <EntityType>Resource</EntityType>
    <Identity>67402097-ab19-4080-b7dd-ca2896024806</Identity>
    <IsException>true</IsException>
    <IsLinkedPattern>true</IsLinkedPattern>
    <LinkedEntities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>01da6c1a-3a1f-412e-a5a0-6d41b06c6986</d3p1:guid>
      <d3p1:guid>3e6d3238-9c51-4f11-99b1-d33ac18e9d88</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-01-29T03:05:18.4641177Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <UniqueIdentity>37e14be3-ec8f-421f-a1a5-cc1924d5ce79</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-01-29T03:05:18.4641177Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDateTime>
    <EntityType>Resource</EntityType>
    <Identity>67402097-ab19-4080-b7dd-ca2896024806</Identity>
    <IsException>true</IsException>
    <IsLinkedPattern>true</IsLinkedPattern>
    <LinkedEntities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>01da6c1a-3a1f-412e-a5a0-6d41b06c6986</d3p1:guid>
      <d3p1:guid>3e6d3238-9c51-4f11-99b1-d33ac18e9d88</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-01-29T03:05:18.4641177Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <UniqueIdentity>37e14be3-ec8f-421f-a1a5-cc1924d5ce79</UniqueIdentity>
  </BusyPattern>
</ArrayOfBusyPattern>