Room Mode List [GET]

Operation

Get a list of active RoomMode of one Property

GET

https://{environment}.ulysescloud.com/api/{version}/chain/{chainId}/property/{propertyId}/roomMode

Request

Property	Type	Required	Default value	Description
chainId	Integer	true		Unique identificator of the chain.
propertyId	Integer	true		Unique identificator of the property.
offset	Integer	false	0	Offset of the array of results.
limit	Integer	false	10	Limit of results.

Example request

GET https://prod.ulysescloud.com/api/v1/chain/1/property/1/roomMode

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field Type Required Description
id Integer true Unique identifier for the .
code String true Code of the PropertyRoomMode.
name String true
Name of the PropertyRoomMode.
active Boolean true If this entity is active or not.
inactiveReason String false The reason why is not active.
applied Boolean false If this applies to a certain Room or not.

Example response

{
  "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
    }
  ]
}

Field	Type	Required	Description
id	Integer	true	Unique identifier for the .
code	String	true	Code of the PropertyRoomMode.
name	String	true	Name of the PropertyRoomMode.
active	Boolean	true	If this entity is active or not.
inactiveReason	String	false	The reason why is not active.
applied	Boolean	false	If this applies to a certain Room or not.