GET api/v2/{facilityId}/bookings

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

BookingsResponseModel

Name	Type	Additional information
facility_id	globally unique identifier	None.
booking_data	Collection of BookingsResponseDataModel	None.
meta	ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "facility_id": "f376358e-683a-44ca-8620-948557c142d2",
  "booking_data": [
    {
      "ledger_id": "38dcc03b-db8d-4701-8677-758dc95cca9c",
      "unit_id": "77bef685-d519-4bb2-b01c-1550c89805f1",
      "unit_group_id": "701610b0-58b8-4a0f-8db2-c8a324fc968c",
      "unit": "sample string 3",
      "rental_type": "sample string 4",
      "created_date": "2026-08-27T11:00:37.2953719+00:00",
      "booking_start_date": "2026-08-27T11:00:37.2953719+00:00",
      "booking_end_date": "2026-08-27T11:00:37.2953719+00:00",
      "average_nightly_rate": 1.0,
      "nightly_rates": [
        {
          "date": "2026-08-27T11:00:37.2953719+00:00",
          "base_predicted_rate": 2.0,
          "adjustments": 3.0,
          "price_group_occupancy_count": 4.0,
          "price_group_available_count": 5.0,
          "occ_rate_adjustment": 6.0,
          "gross_rate": 7.0,
          "promotion": 8.0,
          "net_rate": 9.0,
          "tax": 10.0
        },
        {
          "date": "2026-08-27T11:00:37.2953719+00:00",
          "base_predicted_rate": 2.0,
          "adjustments": 3.0,
          "price_group_occupancy_count": 4.0,
          "price_group_available_count": 5.0,
          "occ_rate_adjustment": 6.0,
          "gross_rate": 7.0,
          "promotion": 8.0,
          "net_rate": 9.0,
          "tax": 10.0
        }
      ],
      "address_city": "sample string 5",
      "address_state": "sample string 6",
      "address_postal": "sample string 7",
      "equipment_type": "sample string 8",
      "equipment_length": 1,
      "num_adults": 1,
      "num_children": 1,
      "num_free": 1,
      "has_pets": true,
      "has_slide_outs": true
    },
    {
      "ledger_id": "38dcc03b-db8d-4701-8677-758dc95cca9c",
      "unit_id": "77bef685-d519-4bb2-b01c-1550c89805f1",
      "unit_group_id": "701610b0-58b8-4a0f-8db2-c8a324fc968c",
      "unit": "sample string 3",
      "rental_type": "sample string 4",
      "created_date": "2026-08-27T11:00:37.2953719+00:00",
      "booking_start_date": "2026-08-27T11:00:37.2953719+00:00",
      "booking_end_date": "2026-08-27T11:00:37.2953719+00:00",
      "average_nightly_rate": 1.0,
      "nightly_rates": [
        {
          "date": "2026-08-27T11:00:37.2953719+00:00",
          "base_predicted_rate": 2.0,
          "adjustments": 3.0,
          "price_group_occupancy_count": 4.0,
          "price_group_available_count": 5.0,
          "occ_rate_adjustment": 6.0,
          "gross_rate": 7.0,
          "promotion": 8.0,
          "net_rate": 9.0,
          "tax": 10.0
        },
        {
          "date": "2026-08-27T11:00:37.2953719+00:00",
          "base_predicted_rate": 2.0,
          "adjustments": 3.0,
          "price_group_occupancy_count": 4.0,
          "price_group_available_count": 5.0,
          "occ_rate_adjustment": 6.0,
          "gross_rate": 7.0,
          "promotion": 8.0,
          "net_rate": 9.0,
          "tax": 10.0
        }
      ],
      "address_city": "sample string 5",
      "address_state": "sample string 6",
      "address_postal": "sample string 7",
      "equipment_type": "sample string 8",
      "equipment_length": 1,
      "num_adults": 1,
      "num_children": 1,
      "num_free": 1,
      "has_pets": true,
      "has_slide_outs": true
    }
  ],
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "71309a42-8185-4d9f-be0c-772aa54a6f6b",
    "error_code": 1,
    "status_message": "sample string 3",
    "status_cat": "http://httpcats.herokuapp.com/2",
    "request_method": "sample string 4",
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 1,
      "total_entries": 1,
      "previous_page": 1,
      "next_page": 1
    },
    "parameters": {}
  }
}

application/xml, text/xml

Sample:

<BookingsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.Bookings">
  <Meta xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
    <ErrorCode>1</ErrorCode>
    <HttpStatusCode>2</HttpStatusCode>
    <HttpStatusMessage>sample string 3</HttpStatusMessage>
    <Message>sample string 1</Message>
    <PaginationData>
      <CurrentPage>1</CurrentPage>
      <NextPage>1</NextPage>
      <PerPage>1</PerPage>
      <PreviousPage>1</PreviousPage>
      <TotalEntries>1</TotalEntries>
      <TotalPages>1</TotalPages>
    </PaginationData>
    <Parameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
    <RequestId>71309a42-8185-4d9f-be0c-772aa54a6f6b</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <BookingData>
    <BookingsResponseDataModel>
      <AddressCity>sample string 5</AddressCity>
      <AddressPostal>sample string 7</AddressPostal>
      <AddressState>sample string 6</AddressState>
      <AverageNightlyRate>1</AverageNightlyRate>
      <BookingEndDate>2026-08-27T11:00:37.2953719+00:00</BookingEndDate>
      <BookingStartDate>2026-08-27T11:00:37.2953719+00:00</BookingStartDate>
      <CreatedDate>2026-08-27T11:00:37.2953719+00:00</CreatedDate>
      <EquipmentLength>1</EquipmentLength>
      <EquipmentType>sample string 8</EquipmentType>
      <HasPets>true</HasPets>
      <HasSlideOuts>true</HasSlideOuts>
      <LedgerId>38dcc03b-db8d-4701-8677-758dc95cca9c</LedgerId>
      <NightlyRates>
        <NightlyRateResponseDataModel>
          <Adjustments>3</Adjustments>
          <BasePredictedRate>2</BasePredictedRate>
          <Date>2026-08-27T11:00:37.2953719+00:00</Date>
          <GrossRate>7</GrossRate>
          <NetRate>9</NetRate>
          <OccRateAdjustment>6</OccRateAdjustment>
          <PriceGroupAvailableCount>5</PriceGroupAvailableCount>
          <PriceGroupOccupancyCount>4</PriceGroupOccupancyCount>
          <Promotion>8</Promotion>
          <Tax>10</Tax>
        </NightlyRateResponseDataModel>
        <NightlyRateResponseDataModel>
          <Adjustments>3</Adjustments>
          <BasePredictedRate>2</BasePredictedRate>
          <Date>2026-08-27T11:00:37.2953719+00:00</Date>
          <GrossRate>7</GrossRate>
          <NetRate>9</NetRate>
          <OccRateAdjustment>6</OccRateAdjustment>
          <PriceGroupAvailableCount>5</PriceGroupAvailableCount>
          <PriceGroupOccupancyCount>4</PriceGroupOccupancyCount>
          <Promotion>8</Promotion>
          <Tax>10</Tax>
        </NightlyRateResponseDataModel>
      </NightlyRates>
      <NumAdults>1</NumAdults>
      <NumChildren>1</NumChildren>
      <NumFree>1</NumFree>
      <RentalType>sample string 4</RentalType>
      <Unit>sample string 3</Unit>
      <UnitGroupId>701610b0-58b8-4a0f-8db2-c8a324fc968c</UnitGroupId>
      <UnitId>77bef685-d519-4bb2-b01c-1550c89805f1</UnitId>
    </BookingsResponseDataModel>
    <BookingsResponseDataModel>
      <AddressCity>sample string 5</AddressCity>
      <AddressPostal>sample string 7</AddressPostal>
      <AddressState>sample string 6</AddressState>
      <AverageNightlyRate>1</AverageNightlyRate>
      <BookingEndDate>2026-08-27T11:00:37.2953719+00:00</BookingEndDate>
      <BookingStartDate>2026-08-27T11:00:37.2953719+00:00</BookingStartDate>
      <CreatedDate>2026-08-27T11:00:37.2953719+00:00</CreatedDate>
      <EquipmentLength>1</EquipmentLength>
      <EquipmentType>sample string 8</EquipmentType>
      <HasPets>true</HasPets>
      <HasSlideOuts>true</HasSlideOuts>
      <LedgerId>38dcc03b-db8d-4701-8677-758dc95cca9c</LedgerId>
      <NightlyRates>
        <NightlyRateResponseDataModel>
          <Adjustments>3</Adjustments>
          <BasePredictedRate>2</BasePredictedRate>
          <Date>2026-08-27T11:00:37.2953719+00:00</Date>
          <GrossRate>7</GrossRate>
          <NetRate>9</NetRate>
          <OccRateAdjustment>6</OccRateAdjustment>
          <PriceGroupAvailableCount>5</PriceGroupAvailableCount>
          <PriceGroupOccupancyCount>4</PriceGroupOccupancyCount>
          <Promotion>8</Promotion>
          <Tax>10</Tax>
        </NightlyRateResponseDataModel>
        <NightlyRateResponseDataModel>
          <Adjustments>3</Adjustments>
          <BasePredictedRate>2</BasePredictedRate>
          <Date>2026-08-27T11:00:37.2953719+00:00</Date>
          <GrossRate>7</GrossRate>
          <NetRate>9</NetRate>
          <OccRateAdjustment>6</OccRateAdjustment>
          <PriceGroupAvailableCount>5</PriceGroupAvailableCount>
          <PriceGroupOccupancyCount>4</PriceGroupOccupancyCount>
          <Promotion>8</Promotion>
          <Tax>10</Tax>
        </NightlyRateResponseDataModel>
      </NightlyRates>
      <NumAdults>1</NumAdults>
      <NumChildren>1</NumChildren>
      <NumFree>1</NumFree>
      <RentalType>sample string 4</RentalType>
      <Unit>sample string 3</Unit>
      <UnitGroupId>701610b0-58b8-4a0f-8db2-c8a324fc968c</UnitGroupId>
      <UnitId>77bef685-d519-4bb2-b01c-1550c89805f1</UnitId>
    </BookingsResponseDataModel>
  </BookingData>
  <FacilityId>f376358e-683a-44ca-8620-948557c142d2</FacilityId>
</BookingsResponseModel>