Room is an object that describes a room of the property.
| Resource | Description |
|---|---|
| GET /v1/Rooms | Get a list with all Rooms of property. |
| GET /v1/RoomsExtended | Get an extended list with all Rooms of property. |
| Name | Type | Description |
|---|---|---|
| id | int | Unique identifier of a Room |
| title | string (255) | Name of Room |
| cleanStatus | int |
Identifier of clean rooms's status
0 - room is not cleaned; 1 - room is cleaned |
| isEnabled | int | 0 - room is not enabled; 1 - room is enabled |
| numAdultsBase | int | The Basic number of adults in the room |
| numAdultsMax | int | Maximum number of adults in the room |
| priority | int | ... |
| roomType | object | Information about roomType of Room |
| roomGroup | object |
Get a list with all Rooms of property.
Request parameters
None
Response
The result is a list of Room objects.
Example Response
<?xml version="1.0" ?>
<Rooms>
<Room>
<Id>1</Id>
<Title>109</Title>
<RoomType>
<Id>2</Id>
<Titles>
<Title languagecode="es">Doble</Title>
</Titles>
</RoomType>
<RoomGroup>
<Id>0</Id>
<Title />
</RoomGroup>
</Room>
<Room>
...
</Room>
...
</Rooms>
[
{
"id":1,
"title":"109",
"roomType":
{
"id":2,
"titles":
[
{
"languageCode":"es",
"title":"Doble"
}
]
},
"roomGroup":
{
"id":0,
"title":""
}
},
{
...
},
...
]
Get an extended list with all Rooms of property.
Request parameters
None
Response
The result is a list of Room objects.
Example Response
<?xml version="1.0"?>
<RoomsExtended>
<RoomExtended>
<Id>1</Id>
<Title>01 FE</Title>
<CleanStatus>0</CleanStatus>
<IsEnabled>1</IsEnabled>
<NumAdultsBase>1</NumAdultsBase>
<NumAdultsMax>2</NumAdultsMax>
<Priority>1</Priority>
<RoomType id="2">
<Titles>
<Title languageCode="en">Front-entry</Title>
</Titles>
</RoomType>
<RoomGroup>
<Id>1</Id>
<Title>Suite A</Title>
</RoomGroup>
</RoomExtended>
...
</RoomExtended>
...
</RoomsExtended>
[
{
"id": 1,
"title": "01 FE",
"cleanStatus": 0,
"isEnabled": 1,
"numAdultsBase": 1,
"numAdultsMax": 2,
"priority": 1,
"roomType": {
"id": 2,
"titles": [
{
"title": "Front-entry",
"languageCode": "en"
}
]
},
"roomGroup": {
"id": 1,
"title": "Suite A"
}
},
]