Versions Compared

Key

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

Operation

Update with PUT the status of Presence value of Room by its id.

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.room


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


.separator{
margin: 5px 0;
}



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

PUT



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

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



Request

PropertyTypeRequiredDefault valueDescription
chainIdStringtrue

Unique identificator of the Chain.

propertyIdStringtrue
Unique identificator of the Property.
roomIdStringtrue
Unique identificator of the Room.
presenceBooleantrue
Value to define presence in Room.


Example request

Code Block
languagepowershell
themeDJango
PUT https://prod.ulysescloud.com/api/v1/chain/1/property/1/room/1/updateStatusPresence?presence=false



Response


PropertyTypeRequiredDescription
ResponseAPIMessageResponseAPIMessagetrueThe response of the operation


Example response

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