GET rooms

Retrieves a list of all available room scenes for each brand associated with the site.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The list of all available room scenes.

Collection of BrandRoomScenes

Name	Description	Type	Additional information
BrandId	Gets or sets the unique identifier for the brand.	integer	None.
RoomScenes	Gets or sets a list of all available room scenes for the brand.	Collection of RoomScene	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "brandId": 1,
    "roomScenes": [
      {
        "roomId": 1,
        "name": "sample string 2",
        "isDefault": true
      },
      {
        "roomId": 1,
        "name": "sample string 2",
        "isDefault": true
      }
    ]
  },
  {
    "brandId": 1,
    "roomScenes": [
      {
        "roomId": 1,
        "name": "sample string 2",
        "isDefault": true
      },
      {
        "roomId": 1,
        "name": "sample string 2",
        "isDefault": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfBrandRoomScenes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tricycle.Studio.Api.Catalog.Models">
  <BrandRoomScenes>
    <BrandId>1</BrandId>
    <RoomScenes>
      <RoomScene>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <RoomId>1</RoomId>
      </RoomScene>
      <RoomScene>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <RoomId>1</RoomId>
      </RoomScene>
    </RoomScenes>
  </BrandRoomScenes>
  <BrandRoomScenes>
    <BrandId>1</BrandId>
    <RoomScenes>
      <RoomScene>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <RoomId>1</RoomId>
      </RoomScene>
      <RoomScene>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <RoomId>1</RoomId>
      </RoomScene>
    </RoomScenes>
  </BrandRoomScenes>
</ArrayOfBrandRoomScenes>