GET api/v2/{facilityId}/booking_unit_groups

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

BookingUnitGroupsResponseModel

Name	Description	Type	Additional information
unit_groups		Collection of BookingUnitGroupResponseDataModel	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "unit_groups": [
    {
      "unit_group_id": "714e63b5-bcab-4bc8-bc66-38abd5f92573",
      "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": "2f66257d-741e-4b24-b328-83331746ba7e",
          "name": "sample string 2"
        },
        {
          "amenity_id": "2f66257d-741e-4b24-b328-83331746ba7e",
          "name": "sample string 2"
        }
      ],
      "unit_type": {
        "unit_type_id": "9c877596-1284-4501-9d3c-01458698b940",
        "name": "sample string 2"
      },
      "unit_group_images": [
        {
          "image_id": "63182a5d-c6db-4462-b77b-098a52549a8a",
          "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": "63182a5d-c6db-4462-b77b-098a52549a8a",
          "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"
        }
      ]
    },
    {
      "unit_group_id": "714e63b5-bcab-4bc8-bc66-38abd5f92573",
      "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": "2f66257d-741e-4b24-b328-83331746ba7e",
          "name": "sample string 2"
        },
        {
          "amenity_id": "2f66257d-741e-4b24-b328-83331746ba7e",
          "name": "sample string 2"
        }
      ],
      "unit_type": {
        "unit_type_id": "9c877596-1284-4501-9d3c-01458698b940",
        "name": "sample string 2"
      },
      "unit_group_images": [
        {
          "image_id": "63182a5d-c6db-4462-b77b-098a52549a8a",
          "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": "63182a5d-c6db-4462-b77b-098a52549a8a",
          "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": "929b917c-dd08-4452-834d-288b02746b37",
    "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:

<BookingUnitGroupsResponseModel 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>929b917c-dd08-4452-834d-288b02746b37</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <UnitGroups>
    <BookingUnitGroupResponseDataModel>
      <Area>1</Area>
      <BookingUnitType>
        <BookingUnitTypeId>9c877596-1284-4501-9d3c-01458698b940</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:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingShared">
        <d4p1:BookingAmenity>
          <d4p1:BookingAmenityId>2f66257d-741e-4b24-b328-83331746ba7e</d4p1:BookingAmenityId>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:BookingAmenity>
        <d4p1:BookingAmenity>
          <d4p1:BookingAmenityId>2f66257d-741e-4b24-b328-83331746ba7e</d4p1:BookingAmenityId>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:BookingAmenity>
      </UnitAmenities>
      <UnitGroupId>714e63b5-bcab-4bc8-bc66-38abd5f92573</UnitGroupId>
      <UnitGroupImages 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>63182a5d-c6db-4462-b77b-098a52549a8a</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>63182a5d-c6db-4462-b77b-098a52549a8a</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>
      </UnitGroupImages>
      <Width>1</Width>
    </BookingUnitGroupResponseDataModel>
    <BookingUnitGroupResponseDataModel>
      <Area>1</Area>
      <BookingUnitType>
        <BookingUnitTypeId>9c877596-1284-4501-9d3c-01458698b940</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:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.BookingModels.BookingShared">
        <d4p1:BookingAmenity>
          <d4p1:BookingAmenityId>2f66257d-741e-4b24-b328-83331746ba7e</d4p1:BookingAmenityId>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:BookingAmenity>
        <d4p1:BookingAmenity>
          <d4p1:BookingAmenityId>2f66257d-741e-4b24-b328-83331746ba7e</d4p1:BookingAmenityId>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:BookingAmenity>
      </UnitAmenities>
      <UnitGroupId>714e63b5-bcab-4bc8-bc66-38abd5f92573</UnitGroupId>
      <UnitGroupImages 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>63182a5d-c6db-4462-b77b-098a52549a8a</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>63182a5d-c6db-4462-b77b-098a52549a8a</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>
      </UnitGroupImages>
      <Width>1</Width>
    </BookingUnitGroupResponseDataModel>
  </UnitGroups>
</BookingUnitGroupsResponseModel>