GET api/HA/availability/{HAExternalID}

Request Information

URI Parameters

Name	Description	Type	Additional information
HAExternalID		string	Required

Body Parameters

None.

Response Information

Resource Description

ListingUnitAvailability

Name	Type	Additional information
listingExternalId	string	None.
unitExternalId	string	None.
unitAvailability	UnitAvailability	None.

Response Formats

application/json, text/json

Sample:

{
  "listingExternalIdField": "sample string 1",
  "unitExternalIdField": "sample string 2",
  "unitAvailabilityField": {
    "availabilityDefaultField": "sample string 1",
    "availabilityUpdatedField": "2025-12-10T06:00:34.7007793+00:00",
    "availabilityUpdatedFieldSpecified": true,
    "availableUnitCountDefaultField": 4,
    "changeOverDefaultField": "sample string 5",
    "dateRangeField": {
      "itemsField": [
        "2025-12-10T06:00:34.7007793+00:00",
        "2025-12-10T06:00:34.7007793+00:00"
      ],
      "itemsElementNameField": [
        0,
        0
      ]
    },
    "maxStayDefaultField": 6,
    "minPriorNotifyDefaultField": 7,
    "minStayDefaultField": 8,
    "stayIncrementDefaultField": "sample string 9",
    "unitAvailabilityConfigurationField": {
      "availabilityField": "sample string 1",
      "availableUnitCountField": "sample string 2",
      "changeOverField": "sample string 3",
      "maxStayField": "sample string 4",
      "minPriorNotifyField": "sample string 5",
      "minStayField": "sample string 6",
      "stayIncrementField": "sample string 7"
    },
    "insertedField": "2025-12-10T06:00:34.7007793+00:00",
    "insertedFieldSpecified": true,
    "updatedField": "2025-12-10T06:00:34.7007793+00:00",
    "updatedFieldSpecified": true
  }
}

application/xml, text/xml

Sample:

<unitAvailabilityContent xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <listingExternalId>sample string 1</listingExternalId>
  <unitExternalId>sample string 2</unitExternalId>
  <unitAvailability>
    <inserted>2025-12-10T06:00:34.7007793+00:00</inserted>
    <updated>2025-12-10T06:00:34.7007793+00:00</updated>
    <availabilityDefault>sample string 1</availabilityDefault>
    <availabilityUpdated>2025-12-10T06:00:34.7007793+00:00</availabilityUpdated>
    <availableUnitCountDefault>4</availableUnitCountDefault>
    <changeOverDefault>sample string 5</changeOverDefault>
    <dateRange>
      <beginDate>2025-12-10</beginDate>
      <beginDate>2025-12-10</beginDate>
    </dateRange>
    <maxStayDefault>6</maxStayDefault>
    <minPriorNotifyDefault>7</minPriorNotifyDefault>
    <minStayDefault>8</minStayDefault>
    <stayIncrementDefault>sample string 9</stayIncrementDefault>
    <unitAvailabilityConfiguration>
      <availability>sample string 1</availability>
      <availableUnitCount>sample string 2</availableUnitCount>
      <changeOver>sample string 3</changeOver>
      <maxStay>sample string 4</maxStay>
      <minPriorNotify>sample string 5</minPriorNotify>
      <minStay>sample string 6</minStay>
      <stayIncrement>sample string 7</stayIncrement>
    </unitAvailabilityConfiguration>
  </unitAvailability>
</unitAvailabilityContent>