Versions Compared

Old Version 1

changes.mady.by.user David Garcerán

Saved on

compared with

New Version 2

changes.mady.by.user David Garcerán

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of Entitypms.integration.room


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: greenkhaki; color: whiteblack; display: inline-block; padding: 5px; border-radius: 3px;

PUT



Div
stylebackground-color: khaki#0a2b1d; color:black; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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



Request

StringDescription of the field.
PropertyTypeRequiredDefault valueDescriptionname
chainIdIntegertrue

propertyIdIntegertrue

roomIdIntegertrue


Example request

Code Block
languagepowershell
themeDJango
PUT https://prod.ulysescloud.com/api/v1/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.

Insert excerpt
PropertyRoomMode
PropertyRoomMode
nopaneltrue


Example body

The body that will be sent in the operation

Code Block
themeDJango
[{
		"id": 14,
		"createdDatename": "2018-04-12T18:13:50.710ZDon't disturb",
		"code": "CCRT1DND",
		"nameactive": "ChainCancellationReasonType 1" }

Response

PropertyTypeRequiredDescriptionPagePagetrueDescription of the response of the success operation

Entity

PropertyTypeRequiredDescriptionIdStringtrueUnique identifier of the entity.CreatedDateDatetrueThe date when the entity was persisted on the database.

Example response

Code Block
themeDJango
{
  "count": 10,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 1,
      "createdDate": "2018-04-12T18:13:50.710Z",
      "code": "CCRT1",
      "name": "ChainCancellationReasonType 1"
    },
    {
      "id": 2,
      "createdDate": "2018-04-12T18:13:50.717Z",
      "code": "CCRT2",
      "name": "ChainCancellationReasonType 2"
    },
    {
      "id": 3,
      "createdDate": "2018-04-12T18:13:50.720Z",
      "code": "CCRT3",
      "name": "ChainCancellationReasonType 3"
    }
  ]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

PropertyTypeRequiredDescription
responseApiMessageResponseApiMessagetrueDescription of the response of the success operation

Example response

Code Block
themeDJango
{
	"httpStatus": "201",
	"userMessage": "Success",
	"technicalMessage": "Success room modes updated",
	"errorCode": "0",
	"moreInfo": "",
	"id": 0,
	"entity": null
}