POST api/BookingTypes/{bookingTypeIdentity}/BookableResourceGroupsAndResources

Request Information

URI Parameters

Name	Description	Type	Additional information
bookingTypeIdentity		string	Required

Body Parameters

ResourceDataFilter

Name	Type	Additional information
Properties	Collection of ResourceDatum	None.
PageNumber	integer	None.
ItemsPerPage	integer	None.
Query	string	None.
ResourceGroupIdentities	Collection of globally unique identifier	None.
LoadedIdentities	Collection of string	None.
CheckAvailability	boolean	None.
IsAdminPrimaryResourceSearch	boolean	None.
RangeStartTime	date	None.
RangeEndTime	date	None.
RangeStartDate	date	None.
RangeEndDate	date	None.
Duration	decimal number	None.
RecurrencePattern	RecurrencePatternObject	None.

Request Formats

application/json, text/json

Sample:

{
  "Properties": [
    {
      "Value": {},
      "ValueType": "sample string 2",
      "ValueChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "DisplayName": "sample string 3",
      "ValueChoicesWithId": [
        {
          "Identity": "1180ffbf-2c0d-4137-b32d-173f5ee22236",
          "Name": "sample string 2"
        },
        {
          "Identity": "1180ffbf-2c0d-4137-b32d-173f5ee22236",
          "Name": "sample string 2"
        }
      ],
      "IsObsolete": true,
      "RelatedObsoleteProperty": "2bdba643-9d3c-40f6-94cf-dfb82c771d96",
      "Identity": "29f26890-dc0f-4463-92f7-372003f6b582",
      "Name": "sample string 7"
    },
    {
      "Value": {},
      "ValueType": "sample string 2",
      "ValueChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "DisplayName": "sample string 3",
      "ValueChoicesWithId": [
        {
          "Identity": "1180ffbf-2c0d-4137-b32d-173f5ee22236",
          "Name": "sample string 2"
        },
        {
          "Identity": "1180ffbf-2c0d-4137-b32d-173f5ee22236",
          "Name": "sample string 2"
        }
      ],
      "IsObsolete": true,
      "RelatedObsoleteProperty": "2bdba643-9d3c-40f6-94cf-dfb82c771d96",
      "Identity": "29f26890-dc0f-4463-92f7-372003f6b582",
      "Name": "sample string 7"
    }
  ],
  "PageNumber": 1,
  "ItemsPerPage": 2,
  "Query": "sample string 3",
  "ResourceGroupIdentities": [
    "cb6bd0a4-c0c0-4ad0-a4d1-927a17a2b136",
    "586d8cd4-1ca2-4e59-a266-69326e377a9e"
  ],
  "LoadedIdentities": [
    "sample string 1",
    "sample string 2"
  ],
  "CheckAvailability": true,
  "IsAdminPrimaryResourceSearch": true,
  "RangeStartTime": "2025-04-03T22:55:12.6066103+00:00",
  "RangeEndTime": "2025-04-03T22:55:12.6066103+00:00",
  "RangeStartDate": "2025-04-03T22:55:12.6066103+00:00",
  "RangeEndDate": "2025-04-03T22:55:12.6066103+00:00",
  "Duration": 10.1,
  "RecurrencePattern": {
    "RecurrenceType": 0,
    "EndDateTime": "2025-04-03T22:55:12.6066103+00:00",
    "StartDateTime": "2025-04-03T22:55:12.6066103+00:00",
    "Interval": 3,
    "UntilType": 0,
    "UntilDate": "2025-04-03T22:55:12.6066103+00:00",
    "NumberOfOccurrences": 5,
    "RecurrenceDescription": "sample string 6",
    "RecurrencePatternComplexDescription": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<ResourceDataFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <Duration>10.1</Duration>
  <RangeEndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-03T22:55:12.6066103Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RangeEndDate>
  <RangeEndTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-03T22:55:12.6066103Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RangeEndTime>
  <RangeStartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-03T22:55:12.6066103Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RangeStartDate>
  <RangeStartTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-03T22:55:12.6066103Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RangeStartTime>
  <RecurrencePattern>
    <EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-04-03T22:55:12.6066103Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDateTime>
    <Interval>3</Interval>
    <NumberOfOccurrences>5</NumberOfOccurrences>
    <RecurrenceDescription>sample string 6</RecurrenceDescription>
    <RecurrencePatternComplexDescription>sample string 7</RecurrencePatternComplexDescription>
    <RecurrenceType>Daily</RecurrenceType>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-04-03T22:55:12.6066103Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDateTime>
    <UntilDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-04-03T22:55:12.6066103Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UntilDate>
    <UntilType>NumberOfOccurrences</UntilType>
  </RecurrencePattern>
  <CheckAvailability>true</CheckAvailability>
  <IsAdminPrimaryResourceSearch>true</IsAdminPrimaryResourceSearch>
  <ItemsPerPage>2</ItemsPerPage>
  <LoadedIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LoadedIdentities>
  <PageNumber>1</PageNumber>
  <Properties>
    <ResourceDatum>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">29f26890-dc0f-4463-92f7-372003f6b582</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name>
      <DisplayName>sample string 3</DisplayName>
      <IsObsolete>true</IsObsolete>
      <RelatedObsoleteProperty>2bdba643-9d3c-40f6-94cf-dfb82c771d96</RelatedObsoleteProperty>
      <Value />
      <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueChoices>
      <ValueChoicesWithId xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
        <d4p1:NamedObject>
          <d4p1:Identity>1180ffbf-2c0d-4137-b32d-173f5ee22236</d4p1:Identity>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:NamedObject>
        <d4p1:NamedObject>
          <d4p1:Identity>1180ffbf-2c0d-4137-b32d-173f5ee22236</d4p1:Identity>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:NamedObject>
      </ValueChoicesWithId>
      <ValueType>sample string 2</ValueType>
    </ResourceDatum>
    <ResourceDatum>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">29f26890-dc0f-4463-92f7-372003f6b582</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name>
      <DisplayName>sample string 3</DisplayName>
      <IsObsolete>true</IsObsolete>
      <RelatedObsoleteProperty>2bdba643-9d3c-40f6-94cf-dfb82c771d96</RelatedObsoleteProperty>
      <Value />
      <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ValueChoices>
      <ValueChoicesWithId xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
        <d4p1:NamedObject>
          <d4p1:Identity>1180ffbf-2c0d-4137-b32d-173f5ee22236</d4p1:Identity>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:NamedObject>
        <d4p1:NamedObject>
          <d4p1:Identity>1180ffbf-2c0d-4137-b32d-173f5ee22236</d4p1:Identity>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:NamedObject>
      </ValueChoicesWithId>
      <ValueType>sample string 2</ValueType>
    </ResourceDatum>
  </Properties>
  <Query>sample string 3</Query>
  <ResourceGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>cb6bd0a4-c0c0-4ad0-a4d1-927a17a2b136</d2p1:guid>
    <d2p1:guid>586d8cd4-1ca2-4e59-a266-69326e377a9e</d2p1:guid>
  </ResourceGroupIdentities>
</ResourceDataFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BookingFilterResults

Name	Description	Type	Additional information
ResourceGroups		Collection of BookableResourceGroupResult	None.
Resources		Collection of BookableResourceResult	None.

Response Formats

application/json, text/json

Sample:

{
  "ResourceGroups": [
    {
      "Description": "sample string 1",
      "BookableResources": [
        {
          "Description": "sample string 1",
          "Identity": "5f51efd4-57aa-4e34-9c67-799bd3d0ae10",
          "Name": "sample string 3"
        },
        {
          "Description": "sample string 1",
          "Identity": "5f51efd4-57aa-4e34-9c67-799bd3d0ae10",
          "Name": "sample string 3"
        }
      ],
      "ResourceCount": 2,
      "Identity": "1a7bd4b6-7c31-4bb6-a368-d43b065d9f79",
      "Name": "sample string 4"
    },
    {
      "Description": "sample string 1",
      "BookableResources": [
        {
          "Description": "sample string 1",
          "Identity": "5f51efd4-57aa-4e34-9c67-799bd3d0ae10",
          "Name": "sample string 3"
        },
        {
          "Description": "sample string 1",
          "Identity": "5f51efd4-57aa-4e34-9c67-799bd3d0ae10",
          "Name": "sample string 3"
        }
      ],
      "ResourceCount": 2,
      "Identity": "1a7bd4b6-7c31-4bb6-a368-d43b065d9f79",
      "Name": "sample string 4"
    }
  ],
  "Resources": [
    {
      "Description": "sample string 1",
      "Identity": "5f51efd4-57aa-4e34-9c67-799bd3d0ae10",
      "Name": "sample string 3"
    },
    {
      "Description": "sample string 1",
      "Identity": "5f51efd4-57aa-4e34-9c67-799bd3d0ae10",
      "Name": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<BookingFilterResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <ResourceGroups>
    <BookableResourceGroupResult>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">1a7bd4b6-7c31-4bb6-a368-d43b065d9f79</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
      <BookableResources>
        <BookableResourceResult>
          <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5f51efd4-57aa-4e34-9c67-799bd3d0ae10</Identity>
          <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
          <Description>sample string 1</Description>
        </BookableResourceResult>
        <BookableResourceResult>
          <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5f51efd4-57aa-4e34-9c67-799bd3d0ae10</Identity>
          <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
          <Description>sample string 1</Description>
        </BookableResourceResult>
      </BookableResources>
      <Description>sample string 1</Description>
      <ResourceCount>2</ResourceCount>
    </BookableResourceGroupResult>
    <BookableResourceGroupResult>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">1a7bd4b6-7c31-4bb6-a368-d43b065d9f79</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
      <BookableResources>
        <BookableResourceResult>
          <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5f51efd4-57aa-4e34-9c67-799bd3d0ae10</Identity>
          <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
          <Description>sample string 1</Description>
        </BookableResourceResult>
        <BookableResourceResult>
          <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5f51efd4-57aa-4e34-9c67-799bd3d0ae10</Identity>
          <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
          <Description>sample string 1</Description>
        </BookableResourceResult>
      </BookableResources>
      <Description>sample string 1</Description>
      <ResourceCount>2</ResourceCount>
    </BookableResourceGroupResult>
  </ResourceGroups>
  <Resources>
    <BookableResourceResult>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5f51efd4-57aa-4e34-9c67-799bd3d0ae10</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
      <Description>sample string 1</Description>
    </BookableResourceResult>
    <BookableResourceResult>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5f51efd4-57aa-4e34-9c67-799bd3d0ae10</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
      <Description>sample string 1</Description>
    </BookableResourceResult>
  </Resources>
</BookingFilterResults>