GET api/v2/{facilityId}/booking_unit_groups/{unitGroupId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facilityId | globally unique identifier |
Required |
|
| unitGroupId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
BookingUnitGroupResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| unit_group | BookingUnitGroupResponseDataModel |
None. |
|
| meta | ApiResponseMeta |
None. |
Response Formats
application/json, text/json
Sample:
{
"unit_group": {
"unit_group_id": "53f86a67-9d4e-4bab-a9e0-040201a79713",
"name": "sample string 2",
"total_units_count": 3,
"starting_at_price": 1.0,
"size": "sample string 4",
"floor": 1,
"area": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"description": "sample string 5",
"unit_amenities": [
{
"amenity_id": "cfeb9b5b-f736-47be-b19e-e113fa4e20a7",
"name": "sample string 2"
},
{
"amenity_id": "cfeb9b5b-f736-47be-b19e-e113fa4e20a7",
"name": "sample string 2"
}
],
"unit_type": {
"unit_type_id": "7874ca04-1442-4e1e-bc04-282694d68e6f",
"name": "sample string 2"
},
"unit_group_images": [
{
"image_id": "f81283e1-4546-44bd-9427-e6fd96d3ede1",
"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": "f81283e1-4546-44bd-9427-e6fd96d3ede1",
"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"
}
]
},
"meta": {
"message": "sample string 1",
"status_code": 2,
"request_id": "9039bb2c-9bef-4ef4-99cf-59b3a039ea31",
"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:
<BookingUnitGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingUnitGroups">
<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>9039bb2c-9bef-4ef4-99cf-59b3a039ea31</RequestId>
<RequestMethod>sample string 4</RequestMethod>
</Meta>
<BookingUnitGroup>
<Area>1</Area>
<BookingUnitType>
<BookingUnitTypeId>7874ca04-1442-4e1e-bc04-282694d68e6f</BookingUnitTypeId>
<Name>sample string 2</Name>
</BookingUnitType>
<Description>sample string 5</Description>
<Floor>1</Floor>
<Height>1</Height>
<Length>1</Length>
<Name>sample string 2</Name>
<Size>sample string 4</Size>
<StartingAtPrice>1</StartingAtPrice>
<TotalUnitsCount>3</TotalUnitsCount>
<UnitAmenities xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingShared">
<d3p1:BookingAmenity>
<d3p1:BookingAmenityId>cfeb9b5b-f736-47be-b19e-e113fa4e20a7</d3p1:BookingAmenityId>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:BookingAmenity>
<d3p1:BookingAmenity>
<d3p1:BookingAmenityId>cfeb9b5b-f736-47be-b19e-e113fa4e20a7</d3p1:BookingAmenityId>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:BookingAmenity>
</UnitAmenities>
<UnitGroupId>53f86a67-9d4e-4bab-a9e0-040201a79713</UnitGroupId>
<UnitGroupImages xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Images">
<d3p1:ImageApiModel>
<d3p1:Caption>sample string 3</d3p1:Caption>
<d3p1:ImageId>f81283e1-4546-44bd-9427-e6fd96d3ede1</d3p1:ImageId>
<d3p1:ImageUrl>sample string 2</d3p1:ImageUrl>
<d3p1:IsHeroImage>true</d3p1:IsHeroImage>
<d3p1:Order>sample string 4</d3p1:Order>
<d3p1:SeoDescription>sample string 7</d3p1:SeoDescription>
<d3p1:SeoFilename>sample string 6</d3p1:SeoFilename>
</d3p1:ImageApiModel>
<d3p1:ImageApiModel>
<d3p1:Caption>sample string 3</d3p1:Caption>
<d3p1:ImageId>f81283e1-4546-44bd-9427-e6fd96d3ede1</d3p1:ImageId>
<d3p1:ImageUrl>sample string 2</d3p1:ImageUrl>
<d3p1:IsHeroImage>true</d3p1:IsHeroImage>
<d3p1:Order>sample string 4</d3p1:Order>
<d3p1:SeoDescription>sample string 7</d3p1:SeoDescription>
<d3p1:SeoFilename>sample string 6</d3p1:SeoFilename>
</d3p1:ImageApiModel>
</UnitGroupImages>
<Width>1</Width>
</BookingUnitGroup>
</BookingUnitGroupResponseModel>