POST api/v2/Resource/GetResourceAvailabilityAndWhy

Return availability details for the given resources in the window specified taking into consideration recurring conflicts and time fence restrictions

Request Information

URI Parameters

None.

Body Parameters

OAResourceListRequest

Name	Type	Additional information
bookingSource	string	None.
treeId	integer	None.
locationId	integer	None.
groupId	integer	None.
userId	integer	None.
languageId	integer	None.
capacity	integer	None.
resourceClassFilterList	Collection of globally unique identifier	None.
resourceTypeFilterList	Collection of integer	None.
startUtc	date	None.
endUtc	date	None.
udfIdFilterList	Collection of OARequestUdfType	None.
skipDirectConflictCheck	boolean	None.
recurrenceProperties	OfficeRecurrenceProperties	None.
recurrenceType	string	None.
seriesTime	OfficeSeriesTime	None.
resourceIDs	Collection of integer	None.
ianaTimeZone	string	None.

Request Formats

application/json, text/json

Sample:

{
  "bookingSource": "sample string 1",
  "treeId": 2,
  "locationId": 3,
  "groupId": 4,
  "userId": 5,
  "languageId": 6,
  "capacity": 7,
  "resourceClassFilterList": [
    "2f77c6b8-7090-4447-9b80-e1a74d9af713",
    "61e847e2-ce93-420e-9b40-8c97680e9d40"
  ],
  "resourceTypeFilterList": [
    1,
    2
  ],
  "startUtc": "2026-04-04T07:55:47.663171-04:00",
  "endUtc": "2026-04-04T07:55:47.663171-04:00",
  "udfIdFilterList": [
    {
      "id": 1,
      "val": "sample string 2"
    },
    {
      "id": 1,
      "val": "sample string 2"
    }
  ],
  "skipDirectConflictCheck": true,
  "recurrenceProperties": {
    "interval": 1,
    "dayOfMonth": 2,
    "dayOfWeek": "sample string 3",
    "days": [
      "sample string 1",
      "sample string 2"
    ],
    "weekNumber": "sample string 4",
    "month": "sample string 5",
    "firstDayOfWeek": "sample string 6"
  },
  "recurrenceType": "sample string 11",
  "seriesTime": {
    "durationMinutes": 1,
    "endDay": 2,
    "endMonth": 3,
    "endYear": 4,
    "startDay": 5,
    "startMonth": 6,
    "startYear": 7,
    "startTimeMinutes": 8
  },
  "resourceIDs": [
    1,
    2
  ],
  "ianaTimeZone": "sample string 12"
}

application/xml, text/xml

Sample:

<OAResourceListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
  <BookingSource>sample string 1</BookingSource>
  <Capacity>7</Capacity>
  <EndUtc>2026-04-04T07:55:47.663171-04:00</EndUtc>
  <GroupId>4</GroupId>
  <IANATimeZone>sample string 12</IANATimeZone>
  <LanguageId>6</LanguageId>
  <LocationId>3</LocationId>
  <RecurrenceProperties>
    <dayOfMonth>2</dayOfMonth>
    <dayOfWeek>sample string 3</dayOfWeek>
    <days xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </days>
    <firstDayOfWeek>sample string 6</firstDayOfWeek>
    <interval>1</interval>
    <month>sample string 5</month>
    <weekNumber>sample string 4</weekNumber>
  </RecurrenceProperties>
  <RecurrenceType>sample string 11</RecurrenceType>
  <ResourceClassFilterList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>2f77c6b8-7090-4447-9b80-e1a74d9af713</d2p1:guid>
    <d2p1:guid>61e847e2-ce93-420e-9b40-8c97680e9d40</d2p1:guid>
  </ResourceClassFilterList>
  <ResourceIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResourceIDs>
  <ResourceTypeFilterList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResourceTypeFilterList>
  <SeriesTime>
    <durationMinutes>1</durationMinutes>
    <endDay>2</endDay>
    <endMonth>3</endMonth>
    <endYear>4</endYear>
    <startDay>5</startDay>
    <startMonth>6</startMonth>
    <startTimeMinutes>8</startTimeMinutes>
    <startYear>7</startYear>
  </SeriesTime>
  <SkipDirectConflictCheck>true</SkipDirectConflictCheck>
  <StartUtc>2026-04-04T07:55:47.663171-04:00</StartUtc>
  <TreeId>2</TreeId>
  <UdfIdFilterList>
    <OARequestUdfType>
      <Id>1</Id>
      <Val>sample string 2</Val>
    </OARequestUdfType>
    <OARequestUdfType>
      <Id>1</Id>
      <Val>sample string 2</Val>
    </OARequestUdfType>
  </UdfIdFilterList>
  <UserId>5</UserId>
</OAResourceListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of object If non-zero, why the resource is not available. If negative it's a string_id from tbl_string-5431; // This location doesn't allow for reservations on Saturday-5432; // This location doesn't allow for reservations on Sunday-5373; // Multi-Day reservations are not allowed in FMS:Employee-1506; // Resource is unavailable during the specified time.-5549; // You do not have permission to view this resource-5485; // Non-Recurring Reservations Onlyres_free = 0res_busy = 1res_max_reserve = 2 res_max_concurrent = 4res_holiday_blocked = 8 res_soft_limit_violation = 16res_hard_limit_violation = 32 res_long_term_hoteling_violation = 64res_capacity_limit_violation = 128 business_unit_restriction = 256

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.