GET api/v2/{facilityId}/booking_unit_type_contexts
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facilityId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
BookingFacilityUnitTypeContextsResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| facility_unit_type_contexts | Collection of BookingFacilityUnitTypeContextResponseDataModel |
None. |
|
| meta | ApiResponseMeta |
None. |
Response Formats
application/json, text/json
Sample:
{
"facility_unit_type_contexts": [
{
"facility_unit_type_context_id": "1e1caf2e-db5a-4a2f-b0d3-f5cf152d1b81",
"name": "sample string 2",
"description": "sample string 3",
"best_price_this_year_date": "2026-08-27T11:00:09.096875+00:00",
"starting_at_price_low": 1.0,
"starting_at_price_high": 1.0,
"monthly_price": 1.0,
"seasonal_price": 1.0,
"unit_type": {
"unit_type_id": "91603e61-b295-4ffd-8f15-df18702c72bc",
"name": "sample string 2"
},
"images": [
{
"image_id": "eca14a59-cdd4-44a6-9596-ec8b9b542193",
"image_url": "sample string 2",
"caption": "sample string 3",
"order": "sample string 4",
"is_hero_image": true,
"seo_filename": "sample string 6",
"seo_description": "sample string 7"
},
{
"image_id": "eca14a59-cdd4-44a6-9596-ec8b9b542193",
"image_url": "sample string 2",
"caption": "sample string 3",
"order": "sample string 4",
"is_hero_image": true,
"seo_filename": "sample string 6",
"seo_description": "sample string 7"
}
],
"amenities": [
{
"amenity_id": "4db9d6e6-2eac-4002-a733-09edd591df4e",
"name": "sample string 2"
},
{
"amenity_id": "4db9d6e6-2eac-4002-a733-09edd591df4e",
"name": "sample string 2"
}
]
},
{
"facility_unit_type_context_id": "1e1caf2e-db5a-4a2f-b0d3-f5cf152d1b81",
"name": "sample string 2",
"description": "sample string 3",
"best_price_this_year_date": "2026-08-27T11:00:09.096875+00:00",
"starting_at_price_low": 1.0,
"starting_at_price_high": 1.0,
"monthly_price": 1.0,
"seasonal_price": 1.0,
"unit_type": {
"unit_type_id": "91603e61-b295-4ffd-8f15-df18702c72bc",
"name": "sample string 2"
},
"images": [
{
"image_id": "eca14a59-cdd4-44a6-9596-ec8b9b542193",
"image_url": "sample string 2",
"caption": "sample string 3",
"order": "sample string 4",
"is_hero_image": true,
"seo_filename": "sample string 6",
"seo_description": "sample string 7"
},
{
"image_id": "eca14a59-cdd4-44a6-9596-ec8b9b542193",
"image_url": "sample string 2",
"caption": "sample string 3",
"order": "sample string 4",
"is_hero_image": true,
"seo_filename": "sample string 6",
"seo_description": "sample string 7"
}
],
"amenities": [
{
"amenity_id": "4db9d6e6-2eac-4002-a733-09edd591df4e",
"name": "sample string 2"
},
{
"amenity_id": "4db9d6e6-2eac-4002-a733-09edd591df4e",
"name": "sample string 2"
}
]
}
],
"meta": {
"message": "sample string 1",
"status_code": 2,
"request_id": "65c25003-9dc3-4155-a591-755fae9b15f0",
"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:
<BookingFacilityUnitTypeContextsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingFacilityUnitTypeContexts">
<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>65c25003-9dc3-4155-a591-755fae9b15f0</RequestId>
<RequestMethod>sample string 4</RequestMethod>
</Meta>
<BookingFacilityUnitTypeContexts>
<BookingFacilityUnitTypeContextResponseDataModel>
<Amenities xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingShared">
<d4p1:BookingAmenity>
<d4p1:BookingAmenityId>4db9d6e6-2eac-4002-a733-09edd591df4e</d4p1:BookingAmenityId>
<d4p1:Name>sample string 2</d4p1:Name>
</d4p1:BookingAmenity>
<d4p1:BookingAmenity>
<d4p1:BookingAmenityId>4db9d6e6-2eac-4002-a733-09edd591df4e</d4p1:BookingAmenityId>
<d4p1:Name>sample string 2</d4p1:Name>
</d4p1:BookingAmenity>
</Amenities>
<BestPriceThisYearDate>2026-08-27T11:00:09.096875+00:00</BestPriceThisYearDate>
<BookingUnitType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingUnitGroups">
<d4p1:BookingUnitTypeId>91603e61-b295-4ffd-8f15-df18702c72bc</d4p1:BookingUnitTypeId>
<d4p1:Name>sample string 2</d4p1:Name>
</BookingUnitType>
<Description>sample string 3</Description>
<FacilityUnitTypeContextId>1e1caf2e-db5a-4a2f-b0d3-f5cf152d1b81</FacilityUnitTypeContextId>
<HeroImages xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Images">
<d4p1:ImageApiModel>
<d4p1:Caption>sample string 3</d4p1:Caption>
<d4p1:ImageId>eca14a59-cdd4-44a6-9596-ec8b9b542193</d4p1:ImageId>
<d4p1:ImageUrl>sample string 2</d4p1:ImageUrl>
<d4p1:IsHeroImage>true</d4p1:IsHeroImage>
<d4p1:Order>sample string 4</d4p1:Order>
<d4p1:SeoDescription>sample string 7</d4p1:SeoDescription>
<d4p1:SeoFilename>sample string 6</d4p1:SeoFilename>
</d4p1:ImageApiModel>
<d4p1:ImageApiModel>
<d4p1:Caption>sample string 3</d4p1:Caption>
<d4p1:ImageId>eca14a59-cdd4-44a6-9596-ec8b9b542193</d4p1:ImageId>
<d4p1:ImageUrl>sample string 2</d4p1:ImageUrl>
<d4p1:IsHeroImage>true</d4p1:IsHeroImage>
<d4p1:Order>sample string 4</d4p1:Order>
<d4p1:SeoDescription>sample string 7</d4p1:SeoDescription>
<d4p1:SeoFilename>sample string 6</d4p1:SeoFilename>
</d4p1:ImageApiModel>
</HeroImages>
<MonthlyPrice>1</MonthlyPrice>
<Name>sample string 2</Name>
<SeasonalPrice>1</SeasonalPrice>
<StartingAtPriceHigh>1</StartingAtPriceHigh>
<StartingAtPriceLow>1</StartingAtPriceLow>
</BookingFacilityUnitTypeContextResponseDataModel>
<BookingFacilityUnitTypeContextResponseDataModel>
<Amenities xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingShared">
<d4p1:BookingAmenity>
<d4p1:BookingAmenityId>4db9d6e6-2eac-4002-a733-09edd591df4e</d4p1:BookingAmenityId>
<d4p1:Name>sample string 2</d4p1:Name>
</d4p1:BookingAmenity>
<d4p1:BookingAmenity>
<d4p1:BookingAmenityId>4db9d6e6-2eac-4002-a733-09edd591df4e</d4p1:BookingAmenityId>
<d4p1:Name>sample string 2</d4p1:Name>
</d4p1:BookingAmenity>
</Amenities>
<BestPriceThisYearDate>2026-08-27T11:00:09.096875+00:00</BestPriceThisYearDate>
<BookingUnitType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingUnitGroups">
<d4p1:BookingUnitTypeId>91603e61-b295-4ffd-8f15-df18702c72bc</d4p1:BookingUnitTypeId>
<d4p1:Name>sample string 2</d4p1:Name>
</BookingUnitType>
<Description>sample string 3</Description>
<FacilityUnitTypeContextId>1e1caf2e-db5a-4a2f-b0d3-f5cf152d1b81</FacilityUnitTypeContextId>
<HeroImages xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Images">
<d4p1:ImageApiModel>
<d4p1:Caption>sample string 3</d4p1:Caption>
<d4p1:ImageId>eca14a59-cdd4-44a6-9596-ec8b9b542193</d4p1:ImageId>
<d4p1:ImageUrl>sample string 2</d4p1:ImageUrl>
<d4p1:IsHeroImage>true</d4p1:IsHeroImage>
<d4p1:Order>sample string 4</d4p1:Order>
<d4p1:SeoDescription>sample string 7</d4p1:SeoDescription>
<d4p1:SeoFilename>sample string 6</d4p1:SeoFilename>
</d4p1:ImageApiModel>
<d4p1:ImageApiModel>
<d4p1:Caption>sample string 3</d4p1:Caption>
<d4p1:ImageId>eca14a59-cdd4-44a6-9596-ec8b9b542193</d4p1:ImageId>
<d4p1:ImageUrl>sample string 2</d4p1:ImageUrl>
<d4p1:IsHeroImage>true</d4p1:IsHeroImage>
<d4p1:Order>sample string 4</d4p1:Order>
<d4p1:SeoDescription>sample string 7</d4p1:SeoDescription>
<d4p1:SeoFilename>sample string 6</d4p1:SeoFilename>
</d4p1:ImageApiModel>
</HeroImages>
<MonthlyPrice>1</MonthlyPrice>
<Name>sample string 2</Name>
<SeasonalPrice>1</SeasonalPrice>
<StartingAtPriceHigh>1</StartingAtPriceHigh>
<StartingAtPriceLow>1</StartingAtPriceLow>
</BookingFacilityUnitTypeContextResponseDataModel>
</BookingFacilityUnitTypeContexts>
</BookingFacilityUnitTypeContextsResponseModel>