Operation
Get a list of active RoomMode of one Property
| Rw ui textbox macro | ||
|---|---|---|
| ||
Only accessible with permission of pmsIntegrationRoom |
| Style |
|---|
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
} |
| Div | ||
|---|---|---|
| ||
GET |
| Div | ||
|---|---|---|
| ||
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/roomMode |
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| propertyId | Integer | true | path parameter | Unique identificator of the property. | |
| offset | Integer | false | request parameter | 0 | Offset of the array of results. |
| limit | Integer | false | request parameter | 10 | Limit of results. |
Example request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/roomMode |
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true | Description of the response of the success operation |
Entity
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example response
| Code Block | ||
|---|---|---|
| ||
{
"count": 3,
"offset": 0,
"limit": 10,
"list": [
{
"id": 4,
"name": "Don't disturb",
"code": "DND",
"active": true,
"inactiveReason": null,
"applied": null
},
{
"id": 5,
"name": "Service requested",
"code": "SER",
"active": true,
"inactiveReason": null,
"applied": null
},
{
"id": 6,
"name": "Cleaning requested",
"code": "CLE",
"active": true,
"inactiveReason": null,
"applied": null
}
]
} |