Update Room Modes [PUT]
Operation
Information of the operation
PUT
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/room/{roomId}/roomMode
Request
Property | Type | Required | Type parameter | Default value | Description |
---|---|---|---|---|---|
chainId | Integer | true | path parameter | ||
propertyId | Integer | true | path parameter | ||
roomId | Integer | true | path parameter |
Example request
PUT https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/2/room/1/roomMode
Body
The body will be an array of elements of PropertyRoomMode with the property "applied" correctly filled with true or false.
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 body
The body that will be sent in the operation
[{ "id": 4, "name": "Don't disturb", "code": "DND", "active": true, "inactiveReason": null, "applied": true }, { "id": 5, "name": "Service requested", "code": "SER", "active": true, "inactiveReason": null, "applied": false }, { "id": 6, "name": "Cleaning requested", "code": "CLE", "active": true, "inactiveReason": null, "applied": true } ]
Response
Property | Type | Required | Description |
---|---|---|---|
responseApiMessage | ResponseApiMessage | true | Description of the response of the success operation |
Example response
{ "httpStatus": "201", "userMessage": "Success", "technicalMessage": "Success room modes updated", "errorCode": "0", "moreInfo": "", "id": 0, "entity": null }